View registered webhook events
GET /api/WebhookRegistrations
Use this call to view the webhook events you are registered to.
Request URL |
---|
https:// .../api/WebhookRegistrations |
JSON response
{
"results": [
{
"registrationId": "00000000-0000-0000-0000-000000000000",
"requestId": "00000000-0000-0000-0000-000000000000",
"callBackUrl": "string",
"callBackUserName": "string",
"callBackPassword": "string",
"merchantId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"deactivatedAt": "2020-12-16T09:31:35.604Z",
"isInErrorState": true,
"errorStateReason": "string",
"detectedErrorStateAt": "2020-12-16T09:31:35.604Z"
}
],
"pageNumber": 0,
"pageSize": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
Attributes
Attribute | Description |
---|---|
pageNumber | The current page number determined by the total number of transactions and the number of transactions per page. |
pageSize | Number of entries listed on a page. |
hasPreviousPage | Confirms if this is the first page of the report. |
hasNextPage | Confirms if this is the last page of the report. |
registrationId | ID of a webhook registration. |
requestId | GUID that accompanies every request. |
callBackUrl | The URL that will receive messages in return. |
callBackUserName | Authentication data that accompanies webhook API calls if the server requires authentication. |
callBackPassword | Authentication data that accompanies webhook API calls if the server requires authentication. |
merchantId | Unique identifier for the merchant. |
isActive | Returns if a webhook is active. |
deactivatedAt | Returns the date and time a webhook was deactivated. |
isInErrorState | Returns if a webhook is in an error status. |
errorStateReason | Returns the reason that a webhook is in an error status. |
detectedErrorStateAt | The moment that an error was detected. This is important information when troubleshooting a problem. |
Updated 7 months ago