Docs

Start here

Registered endpoints and how they are doing

GET/v1/webhookson https://api.auray.ai/v1

Registered endpoints and how they are doing

#Authentication

Authorization: Bearer auray_sk_… — jobs:read — reading is reading.

#Example request

curl https://api.auray.ai/v1/webhooks \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK

FieldTypeRequiredDefaultDescription
objectstringno—
dataobject[]no—
data[].idstringno—
data[].objectstringno—One of "webhook".
data[].urlstringno—A URL.
data[].productsstring[]no—
data[].statusstringno—One of "pending", "active", "disabled", "dead".
data[].consecutive_failuresintegerno—
data[].last_status_codeintegerno—May be null.
data[].disabled_reasonstringno—May be null.
data[].created_atstringno—
data[].verified_atstringno—When the endpoint answered its challenge. Null before it has — and null again if the same URL is re-registered, which resets the endpoint rather than adding a second one. May be null.
data[].last_success_atstringno—When a delivery to this endpoint last succeeded. May be null.
data[].last_failure_atstringno—When one last failed. May be null.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#401 Unauthorized

#403 Forbidden

#429 Too Many Requests

#500 Internal Server Error

profile_read_failed — your endpoints could not be read. An empty list means you have none, never that we could not tell.

The error body: error, message, docs (the entry that explains it) and request_id.

#503 Service Unavailable

#Status codes

StatusMeaning
200OK
401Unauthorized
403Forbidden
429Too Many Requests
500profile_read_failed — your endpoints could not be read.
503Service Unavailable

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close