Retrieve a webhook

Retrieve a webhook with specified identifier string.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Webhook retrieved.

Response Schema: application/json
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.

404

Resource not found.

get/webhooks/{id}
Request samples
const webhook = await api.webhooks.get({id: 'foobar-001'});
console.log(webhook.fields.id);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventsFilter": [ ],
  • "status": "active",
  • "method": "GET",
  • "headers": [
    ],
  • "credentialHash": "string",
  • "body": "string",
  • "filter": "string",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}