AthausDocs

Send a test event

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

Last updated:

Sends one signed event of the type webhook_endpoint.test to the endpoint, now, once, and answers with the result. There is no retry, and the status of the endpoint and its last delivery stay as they are. It is sent even if the endpoint is disabled. Needs write access to webhookEndpoints.

Requires the scope propose.

Request

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

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.
Idempotency-KeystringnoMakes a retry safe: the same key with the same body returns the first answer and writes nothing twice. A random value of at least 128 bits, for example a UUID, 1 to 255 characters. The key is kept for 24 hours and scoped to the API key and this operation. The same key with a different body is a 422; while the first request still runs it is a 409. Only successful answers are kept: after an error the key is free again.

Example

curl -X POST "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17/test" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Idempotency-Key: $(uuidgen)"

Response

On success the status is 200 with WebhookTest.

WebhookTest

FieldTypeDescription
objectstringAlways webhook_test.
endpointIdstring
eventIdstringUUID of the test event. Its type is webhook_endpoint.test.
deliveredbooleanTrue if the receiver answered with a 2xx status.
statusinteger | null
errorstring | nullconnection_refused, timeout, tls_error, http_4xx, http_5xx or address; null if delivered.

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.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.
Idempotent-Replayedtrue when this is the stored answer to an earlier request with the same Idempotency-Key.

Errors

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

StatusCodesMeaning
400invalid_id, 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.
409The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
422The idempotency key was already used with a different request body.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page