AthausDoku

Update a webhook endpoint

Aufruf, Parameter, Antwort und Fehler von PATCH /v1/webhookEndpoints/{id}.

Zuletzt aktualisiert:

Merge Patch: a missing field stays, description: null clears the note, events replaces the list. disabled: true stops deliveries, disabled: false turns a disabled endpoint on again (the URL is checked again). The key needs read access to the resource of every event type the endpoint ends up with, otherwise 403. Needs write access to webhookEndpoints.

Braucht den Scope propose.

Aufruf

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

Parameter

Pfad

NameTypPflichtBeschreibung
idstring (uuid)jaUUID of the webhook endpoint.

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.
If-MatchstringneinOnly if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written.

Rumpf

JSON mit Content-Type: application/json. Ein Feld, das die API nicht kennt, ist ein 400, und errors[].name nennt das Feld. Der Rumpf ist Pflicht.

FeldTypBeschreibung
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. Eines von inquiry.received, message.received, viewing.booked, viewing.canceled, viewing.upcoming, file.processed, proposal.pending, project.created, project.updated, unit.status_updated.
descriptionstring | nullnull clears the note.
disabledbooleantrue stops deliveries, false turns a disabled endpoint on again and clears the reason.

Beispiel

curl -X PATCH "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Content-Type: application/json" \
  -d '{"events":["inquiry.received","message.received"]}'

Antwort

Bei Erfolg kommt 200 mit WebhookEndpoint.

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.
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.

Fehler

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

StatusCodesBedeutung
400invalid_id, api_version_unsupported, invalid_input, 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.
409The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
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.

Weiter lesen

Auf dieser Seite