Events

An event is something that happened to an object of your account: a payment created, succeeded, failed. It is the same event your webhook endpoints are sent, and it is kept for 30 days.

• data.object is the object right after the event, shaped in your request’s API version (its PSP-Version, or your account’s default). Keys inside it may come in another order than in a delivery’s body; their values are the same.
• pending_webhooks counts the endpoints that haven’t received it yet, failed and turned-off ones included.
• GET /events?delivery_success=false lists the events whose delivery to one of your endpoints hasn’t succeeded: what to process after your server was down. An event made while an endpoint was turned off has no delivery to it, so this leaves it out: read those by created.
• type=payment.* lists every type of a resource. Filters combine, and the list pages like every list (Pagination).
• POST /events/{id}/retry with webhook_endpoint sends an event to one of your endpoints again, now: one more attempt of its delivery there, as Resend in the merchant portal. The endpoint must have been sent the event and be turned on: one turned off is 400 parameter_invalid, and an event it wasn’t sent 404 resource_missing on webhook_endpoint. A delivery still being retried keeps its schedule. It takes no Idempotency-Key: the same request again sends the event once more.
• A test key reads test mode’s events, a live key live mode’s.

Endpoints

• GET /eventsListEvents
• GET /events/{id}GetEvent
• POST /events/{id}/retryRetryEvent

Loading the reference…