Retrieve webhooks

Retrieve a list of webhooks.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

List of Webhooks retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
url
required
string <uri>

URL that triggers when the given event occurs.

credentialHash
required
string

Hash from credentials to use for authentication by the given URL.

id
string <= 50 characters

Webhook identifier string.

eventsFilter
Array of strings (GlobalWebhookEventType)
Default: []

Array of System event type.

Items Enum: "aml-list-possibly-matched" "application-instance-disabled" "application-instance-enabled" "balance-transaction-settled" "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided" "customer-created" … 75 more
status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
Array of objects (WebhookHeader)
Array
name
required
string

Name of the property.

value
required
string

Value of the property.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
body
string or null

Webhook request body. If null, the default payload for the given event is used. Template placeholders are permitted.

Invalid placeholders render as an empty strings. For example, Hello {{invalid.placeholder}}! is rendered as Hello !.

For more information, see Placeholders.

filter
string

Filter that determines whether to send the webhook. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filters.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time>

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Links related to resource.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/webhooks
Request samples
// all parameters are optional
const firstCollection = await api.webhooks.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100, sort: '-createdTime'}; 
const secondCollection = await api.webhooks.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(webhook => console.log(webhook.fields.name));
Response samples
application/json
[
  • {
    }
]