v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Webhooks

List webhook messages

Retrieve all webhook messages sent.

Please note that, by default, this endpoint is limited to retrieving 90 days' worth of data relative to now. Messages that date back more than 90 days are still accessible, but their payloads are expunged. If an iterator is provided, the endpoint retrieves data spanning 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the before or after parameter as appropriate.

get/v1/webhooks/messages

Query parameters

beforestring date nullable

Date time string in the ISO 8601 format.

Example:2024-01-20T16:04:11Z

Date time string in the ISO 8601 format.

afterstring date nullable

Date time string in the ISO 8601 format.

Example:2024-01-20T16:04:11Z

Date time string in the ISO 8601 format.

event_typesstring[]

Event types to consider.

Event types to consider.

[
  "customer.created"
]
limitnumber
iteratorstring

Response

Example response

{
  "data": [
    {
      "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "event_id": "evt_9avP4zLks7L1yh",
      "sent_at": "2024-01-20T16:04:11Z"
    }
  ]
}