List Webhook Events
Returns a list of Webhook events belonging to your account.
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2
and<= 100
Default value:
50
The number of records per page to return.
- filter object
The fields, operations, and values to filter the records by.
status object
include string requiredevent object
oneOf- MOD1
- MOD2
like string requiredeq string requiredwebhook_id object
eq string requiredlast_sent_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredretried_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string required
- sort object
The fields and direction to sort the results by.
- id string
Possible values: [
asc
,desc
]Default value:
desc
- retried_at string
Possible values: [
asc
,desc
] - last_sent_at string
Possible values: [
asc
,desc
] - created_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
]
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
- MOD7
status object
include stringevent object
oneOf- MOD1
- MOD2
like stringeq stringwebhook_id object
eq stringlast_sent_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringretried_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
updated_at stringPossible values: [
asc
,desc
]created_at stringPossible values: [
asc
,desc
]last_sent_at stringPossible values: [
asc
,desc
]retried_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]- records object[]
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"status": {
"include": "string"
}
},
{
"event": {
"like": "string"
}
},
{
"webhook_id": {
"eq": "string"
}
},
{
"last_sent_at": {
"lt": "string"
}
},
{
"retried_at": {
"lt": "string"
}
},
{
"created_at": {
"lt": "string"
}
},
{
"updated_at": {
"lt": "string"
}
}
],
"sorted_by": [
{
"updated_at": "asc"
},
{
"created_at": "asc"
},
{
"last_sent_at": "asc"
},
{
"retried_at": "asc"
},
{
"id": "asc"
}
],
"records": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"attempts": 0,
"event": "string",
"last_error": "string",
"last_sent_at": "2023-03-14T13:46:27-06:00",
"payload": "string",
"response_body": "string",
"response_code": 0,
"retried_at": "2023-03-14T13:46:27-06:00",
"status": "string",
"webhook_id": 0
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}