Skip to main content
cURL
Cost: Free.
Needs the webhooks:write scope. Attempts come newest first, by when each was made, or queued for a pending one. Your endpoint’s response body is never stored.

Retries

Any 2xx answer counts as delivered. Anything else, no answer within 15 seconds, or a redirect (never followed) is a failure. Alura tries again 5 seconds, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours and 10 hours later: 8 attempts at most. Each attempt is its own row, with attempt from 1 to 8. next_attempt_at says when the next try is due. Every attempt of one event has the same event_id, sent as the webhook-id header: de-duplicate on it.

Why an attempt failed

http_status is the status your endpoint answered, null when there was no answer.
After 5 days without a successful delivery and at least 20 failed attempts, Alura disables the endpoint: status becomes disabled with disabled_reason: "failing". Fix it, then set status back to enabled with Update webhook. What it missed isn’t sent again.
To check an endpoint now, send a test event and watch it here.

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Path Parameters

id
string
required

The webhook endpoint ID (we_...).

Required string length: 1 - 64
Example:

"we_01JMOCK0000000000000000000"

Query Parameters

limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required