Skip to main content
GET
List Webhooks

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

actionType
string

Parses a comma-separated string.

Examples:

  • UPDATE_PAYMENT,PAYMENT_PAID,UPDATE_ORDER,UPDATE_TRANSFER
Example:

"UPDATE_PAYMENT,PAYMENT_PAID,UPDATE_ORDER,UPDATE_TRANSFER"

createdAt
string

Available operators: >, >=, <, <=, =.

Example:

">=2024-01-01;<=2024-12-31"

externalEventType
string

External provider webhook event type

Example:

"charge.paid"

externalProvider
string

External provider name

Example:

"in_memory"

status
string

Parses a comma-separated string.

Examples:

  • RECEIVED,PROCESSED,FAILED
Example:

"RECEIVED,PROCESSED,FAILED"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
lastReceivedAt,
processedAt,
updatedAt
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List webhooks

data
object[]
required
meta
object
required