Retrieve a webhook endpoint
Aufruf, Parameter, Antwort und Fehler von GET /v1/webhookEndpoints/{id}.
Zuletzt aktualisiert:
Braucht den Scope read.
Aufruf
GET https://api.athaus.ai/v1/webhookEndpoints/{id}Parameter
Pfad
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string (uuid) | ja | UUID of the webhook endpoint. |
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | Optional 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-Match | string | nein | An ETag you hold. If it is still current, the answer is 304 without a body. |
Beispiel
curl "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
-H "Authorization: Bearer ath_live_..."Antwort
Bei Erfolg kommt 200 mit WebhookEndpoint.
WebhookEndpoint
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer webhook_endpoint. |
id | string | UUID of the endpoint. |
url | string | |
description | string | null | |
events | string[] | |
status | string | A disabled endpoint receives nothing. Eines von enabled, disabled. |
disabledReason | string | null | Why 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. |
disabledAt | string (date-time) | null | When 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. |
apiVersion | string | The API version the payloads are shaped in. |
apiKeyId | string | UUID of the API key this endpoint belongs to. When that key ends, the endpoint stops delivering. |
secretRotationEndsAt | string (date-time) | null | While a rotation runs: until when the previous secret also signs. |
lastDelivery | object | null | |
lastDelivery.at | string (date-time) | When the last attempt ran. |
lastDelivery.status | integer | null | The HTTP status of the receiver, or null if it never answered. |
lastDelivery.error | string | null | connection_refused, timeout, tls_error, http_4xx, http_5xx or address; null if it succeeded. |
lastDelivery.failingSince | string (date-time) | null | Since when every attempt fails; null if the last one succeeded. |
createdAt | string (date-time) | |
updatedAt | string (date-time) |
Köpfe der Antwort
| Kopf | Beschreibung |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
ETag | A 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-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Mit If-None-Match auf den aktuellen ETag antwortet die Operation 304 ohne Rumpf.
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | invalid_id, api_version_unsupported, invalid_input | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.