Skip to main content

Get events

Required scopes:

  • partner.webhooks.manage

OData supported operators:

  • logical operators: Or, And, Equal, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
  • arithmetic operators: None
  • functions: None

OData filtering syntax can be seen here. Ordering syntax can be seen here.

Query Parameters
$filter string

Filter the results using OData syntax. Supported properties: created, eventType, deliverySuccess

$orderby string

Order the results using OData syntax. Supported properties: created

$skip int32

Skip the specified number of entries

$top int32

Possible values: value ≤ 100

Get the top X number of records. Max value: 100

Responses
200

OK

Schema — OPTIONAL
items object[]

The page items.

id uuid

The ID of the event.

eventType string

The event that occured.

webhookVersion string

Possible values: [v1, v2]

Version of the payload format.

data

The payload of the event.

created date-time

Time at which the event has been created.

deliverySuccess boolean — OPTIONAL

Status of the event delivery attempt. If all associated delivery attempts are successful, the event is considered delivered and this is true. Otherwise, if any delivery attempt is still pending or unsuccessful, the event is considered undelivered and this is false. If no delivery attempt is associated with the event, this is null.

count int64

Total number of records. When IsCountUnknown is true, this value should be ignored.

isCountUnknown boolean

Indicates whether the total count is unknown or could not be determined. When true, the Count property should be ignored.