Sign in

v1

latestOpenAPI 3.0.12026-08-04123613463.4 KB
Events

Retrieve events

This endpoint lists events, or a subset of events.

get/events

Query parameters

string

Event ID

OR
string[]
'SCHEDULED' | 'QUEUED' | 'HOLD' | 'SUCCESSFUL' | 'FAILED' | 'CANCELLED'
OR
EventStatus[]
string

Connection (webhook) ID

OR
string[]
string

Destination ID

OR
string[]
string
OR
string[]
string

Source ID

OR
string[]
integer
OR
integer
OR
OR
integer[]
string date-time
OR
string date-time
OR
'BAD_RESPONSE' | 'CANCELLED' | 'TIMEOUT' | 'NOT_FOUND' | 'CANCELLED_PAST_RETENTION' | 'CONNECTION_REFUSED' | 'CONNECTION_RESET' | 'MISSING_URL' | 'CLI' | 'CLI_UNAVAILABLE' | 'SELF_SIGNED_CERT' | 'ERR_TLS_CERT_ALTNAME_INVALID' | 'ERR_SSL_WRONG_VERSION_NUMBER' | 'NETWORK_ERROR' | 'NETWORK_REQUEST_CANCELED' | 'NETWORK_UNREACHABLE' | 'TOO_MANY_REDIRECTS' | 'INVALID_CHARACTER' | 'INVALID_URL' | 'SSL_ERROR_CA_UNKNOWN' | 'DATA_ARCHIVED' | 'SSL_CERT_EXPIRED' | 'BULK_RETRY_CANCELLED' | 'DNS_LOOKUP_FAILED' | 'HOST_UNREACHABLE' | 'INTERNAL_ERROR' | 'PROTOCOL_ERROR' | 'PAYLOAD_MISSING' | 'UNABLE_TO_GET_ISSUER_CERT' | 'SOCKET_CLOSED' | 'OAUTH2_HANDSHAKE_FAILED' | 'Z_DATA_ERROR' | 'UNKNOWN'

Error code of the delivery attempt

OR
AttemptErrorCodes[]
string
OR
OR
string[]
string date-time
OR
string date-time
OR
search_termstring

URL Encoded string of the value to match partially to the body, headers, parsed_query or path

string
OR
object
string
OR
object
string
OR
object
pathstring

URL Encoded string of the value to match partially to the path

string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
include'data'

Include the data object in the event model

progressive'true' | 'false'

Enable progressive loading for partial results

order_by'created_at'

Sort key

dir'asc' | 'desc'

Sort direction

limitinteger

Result set size

nextstring

The ID to provide in the query to get the next set of results

prevstring

The ID to provide in the query to get the previous set of results

Response

List of events

countinteger