AthausDocs

Create a webhook endpoint

Request, parameters, response and errors of POST /v1/webhookEndpoints.

Last updated:

Registers an address that receives the listed event types, signed as Standard Webhooks describes. The response carries the signing secret (secret, whsec_...) once; store it, it is not shown again. The endpoint belongs to the key that creates it: when that key is revoked or ends, the endpoint stops delivering. The key needs write access to webhookEndpoints and read access to the resource of every event type it lists, otherwise 403. Only a key created by the management of the office gets webhookEndpoints. At most 20 endpoints per office. The URL must be https on a public address; it is checked again at every delivery. This operation does not take an Idempotency-Key.

Requires the scope propose.

Request

POST https://api.athaus.ai/v1/webhookEndpoints

Parameters

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.

Request body

JSON with Content-Type: application/json. A field the API does not know is a 400, and errors[].name names the field. The body is required.

FieldTypeDescription
urlstringWhere deliveries go: an https URL on a public address, without credentials.
eventsstring[]The event types this endpoint receives. The key needs read access to the resource of each. One of inquiry.received, message.received, viewing.booked, viewing.canceled, viewing.upcoming, file.processed, proposal.pending, project.created, project.updated, unit.status_updated.
descriptionstringA note for yourself, up to 200 characters.

Example

curl -X POST "https://api.athaus.ai/v1/webhookEndpoints" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.org/hooks/athaus","events":["inquiry.received","viewing.booked"],"description":"CRM sync"}'

Response

On success the status is 201 with WebhookEndpointWithSecret.

WebhookEndpointWithSecret

FieldTypeDescription
objectstringAlways webhook_endpoint.
idstringUUID of the endpoint.
urlstring
descriptionstring | null
eventsstring[]
statusstringA disabled endpoint receives nothing. One of enabled, disabled.
disabledReasonstring | nullWhy it is disabled. disabled_by_user: you set disabled. target_not_allowed: the address is not public any more. endpoint_gone: the receiver answered 410. delivery_failing: no delivery succeeded for five days, and Athaus switched it off by itself. key_revoked: the API key that created it ended. One of disabled_by_user, target_not_allowed, endpoint_gone, delivery_failing, key_revoked.
disabledAtstring (date-time) | nullWhen the endpoint was switched off, by you or by Athaus; null while it is enabled. Not set for key_revoked: read the key list for that.
apiVersionstringThe API version the payloads are shaped in.
apiKeyIdstringUUID of the API key this endpoint belongs to. When that key ends, the endpoint stops delivering.
secretRotationEndsAtstring (date-time) | nullWhile a rotation runs: until when the previous secret also signs.
lastDeliveryobject | null
lastDelivery.atstring (date-time)When the last attempt ran.
lastDelivery.statusinteger | nullThe HTTP status of the receiver, or null if it never answered.
lastDelivery.errorstring | nullconnection_refused, timeout, tls_error, http_4xx, http_5xx or address; null if it succeeded.
lastDelivery.failingSincestring (date-time) | nullSince when every attempt fails; null if the last one succeeded.
createdAtstring (date-time)
updatedAtstring (date-time)
secretstringThe signing secret, whsec_ and base64. Shown once; store it now. Verify deliveries with it as Standard Webhooks describes.

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400api_version_unsupported, invalid_bodyInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409webhook_endpoint_limit_exceededThe request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
413payload_too_largeThe request body is larger than 512 KB.
415invalid_inputThe request body is not JSON. Send Content-Type: application/json.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page