Skip to navigation
API ReferenceWebhooksWebhook events

List webhook events

Events from the last 30 days, for catching up and reconciliation. Missed events are not replayed automatically: after an outage, or after an endpoint was disabled, filter by delivery_status or endpoint and send each one you need with POST /v1/webhook_events/{webhook_event_id}/redeliver.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

typeenumOptional
Only events of this type.
related_objectstringOptional
Only events about this object ID.
delivery_statusenumOptional
Only events with this delivery status.
Allowed values:
endpointstringOptional

Only events sent to this webhook endpoint (we_...).

created_afterdatetimeOptional
Only objects created at or after this time.
created_beforedatetimeOptional
Only objects created before this time.
limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

includeenumOptional

Send total_count to add total_count to the list: how many objects match the filters across every page. The count is capped, and total_count_approximate: true says when the real number is higher. It is slower than a plain list, so ask for it when you show a number.

Allowed values:

Response

A page of webhook events.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional
total_countintegerOptional

Only with include=total_count. How many objects match the filters.

total_count_approximatebooleanOptional

Only with include=total_count. True when the count was capped and the real number is higher.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error