AthausDocs

Retrieve a webhook endpoint

Request, parameters, response and errors of GET /v1/webhookEndpoints/{id}.

Last updated:

Requires the scope read.

Try it in the console

Request

GET https://api.athaus.ai/v1/webhookEndpoints/{id}

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the webhook endpoint.

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.
If-None-MatchstringnoAn ETag you hold. If it is still current, the answer is 304 without a body.

Example

curl "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with WebhookEndpoint.

WebhookEndpoint

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)

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.

With If-None-Match naming the current ETag, the operation answers 304 without a body.

Errors

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

StatusCodesMeaning
400invalid_id, api_version_unsupported, invalid_inputInvalid 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.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page