AthausDoku

List webhook endpoints

Aufruf, Parameter, Antwort und Fehler von GET /v1/webhookEndpoints.

Zuletzt aktualisiert:

Returns the webhook endpoints of the office, newest first, with their status and the result of the last delivery. The secret is never part of it. Needs read access to webhookEndpoints.

Braucht den Scope read.

In der Konsole ausprobieren

Aufruf

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

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
cursorstringneinOpaque value from nextCursor of the previous page.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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.

Beispiel

curl "https://api.athaus.ai/v1/webhookEndpoints?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit WebhookEndpointList.

WebhookEndpointList

FeldTypBeschreibung
objectstringImmer list.
dataWebhookEndpoint[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

WebhookEndpoint

FeldTypBeschreibung
objectstringImmer webhook_endpoint.
idstringUUID of the endpoint.
urlstring
descriptionstring | null
eventsstring[]
statusstringA disabled endpoint receives nothing. Eines von 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. Eines von 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)

Köpfe der Antwort

KopfBeschreibung
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.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_query, api_version_unsupportedInvalid 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.

Weiter lesen

Auf dieser Seite