Skip to main content
GET
/
v1
/
events
List webhook events
curl --request GET \
  --url http://127.0.0.1:8787/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "trigger_id": "<string>",
      "created_at": "<string>",
      "deliveries": [
        {
          "id": "<string>",
          "webhook_endpoint_id": "<string>",
          "last_status_code": 123,
          "attempt_count": 123,
          "last_attempt_at": "<string>",
          "payload_expires_at": "<string>",
          "payload_scrubbed_at": "<string>"
        }
      ]
    }
  ],
  "error": null,
  "pagination": {
    "limit": 10,
    "has_more": false,
    "next_cursor": null
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
enum<string>

Filter events by type (e.g. "verification.session.succeeded").

Available options:
verification.session.succeeded,
verification.session.failed,
verification.session.expired,
verification.session.cancelled
created_from
string<date-time>

Return events created at or after this ISO 8601 timestamp.

created_to
string<date-time>

Return events created at or before this ISO 8601 timestamp.

limit
integer

Maximum number of events to return. Defaults to 10 if not specified.

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

Cursor of the last item from the previous page. When provided, the next page of results will be returned.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

Successful operation.

data
object[]
required
error
null
required
pagination
object
required