Retrieve a webhook event
Includes the last 10 delivery attempts to each endpoint.
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.
Path parameters
webhook_event_id
The webhook event ID (whe_...).
Response
The webhook event.
id
object
type
New types may be added. Subscribe only to the ones you handle.
api_version
livemode
created_at
reason
What caused the event.
context
The fields that identify what a limit, window or purchase event is about, for events that don’t name a stored object of their own. Fetch related_object for the current state.
delivery_status
pending: still being sent or retried. succeeded: every subscribed endpoint acknowledged it. failed: retries ran out for at least one endpoint.
Allowed values:
deliveries
Retrieve only. The last 10 attempts per endpoint.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error