Skip to main content
GET
List Events

Authorizations

Authorization
string
header
required

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

Headers

x-partner-id
string
default:""
required

The Partner ID header used for authorization

Path Parameters

webhook_id
string
required

The unique identifier for the webhook

Example:

"whk_cjf0qivsemvkg2on8f9g"

Query Parameters

limit
string
Example:

"20"

page
string
Example:

"1"

delivery_status
enum<string>
Available options:
Undelivered,
Delivered
Example:

"Undelivered"

Response

Response when retrieving a list of events fired against a webhook subscription

Standard response structure for successful operations

ok
boolean

Indicates if the operation was successful

Example:

true

data
object

Contains the response data