Webhook Reference

Request attributes

These are the attributes you can provide when you call webhook requests. Some attributes are required and others are optional.

AttributeDescription
registrationId
string
ID of a webhook registration.
Required
requestId
string
GUID that accompanies every request.
Optional
callBackUrl
string
The URL that will receive messages in return.
callBackUserName
string
Authentication data that accompanies webhook API calls if the server requires authentication.
callBackPassword
string
Authentication data that accompanies webhook API calls if the server requires authentication.
merchantId
string
Unique identifier for the merchant.
deactivatedAt
date
Returns the date and time a webhook was deactivated.
isInErrorState
boolean
True if the webhook is in an error state and fails to send, otherwise false.

A webhook goes into Error state when it fails to send, when a 500 is received from the endpoint to which it was sent.

Even if the webhook is in an error state, we still attempt to send it. If it succeeds, isInErrorState is false, and if it fails, isInErrorState is true.

This doesn't affect if the webhook is tried. It's a flag in the database indicating if there was a problem with this webhook.

Additionally, if a user changes the webhookregistration callbackurl, we reset “iserrorstate” to false.
errorStateReason
string
Returns the reason that a webhook is in an error status.
detectedErrorStateAt
date
The moment that an error was detected. This is important information when troubleshooting a problem.
results
array
Results are below.
hasPreviousPage
boolean
Whether the search result set includes data on previous pages or not.
True if there is data on previous result pages, false if this is the first page of search results.
Optional
hasNextPage
boolean
Whether the search result set includes more data on subsequent pages or not. True if there is more data, false if not.
Optional

Query parameters

These are the query parameters you can add to your request to narrow down the responses you receive when you send a GET call.

ParameterDescription
registrationId
string
ID of a webhook registration.
Required
Path and query parameter
request
array
Request submitted.
Required
isActive
boolean
Whether a webhook is active.
True if it's active, otherwise false.
Optional
pageSize
integer
Number of transactions to list on a page.
Optional
pageNumber
integer
The current page number determined by the total number of transactions and the number of transactions per page.
Optional