Get webhooks by ID
GET /api/WebhookRegistrations/{registrationId}
Use this call to view the webhook events by ID.
Request URL |
---|
https:// .../api/WebhookRegistrations/{registrationId} |
JSON response
{
"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.622Z",
"isInErrorState": true,
"errorStateReason": "string",
"detectedErrorStateAt": "2020-12-16T09:31:35.622Z"
}
Attributes
Attribute | Description |
---|---|
registrationId | ID of a webhook registration. |
pageNumber | The current page number determined by the total number of transactions and the number of transactions per page. |
pageSize | Number of transactions to list on a page. |
hasPreviousPage | Whether the search result set includes data on previous pages or not. |
hasNextPage | Whether the search result set includes more data on subsequent pages or not. True if there is more data, false if not. |
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 | Whether a webhook is active. |
deactivatedAt | Returns the date and time a webhook was deactivated. |
isInErrorState | Whether a webhook is in an error state. |
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 6 months ago