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 integer	The current page number determined by the total number of transactions and the number of transactions per page.
pageSize integer	Number of entries listed on a page.
hasPreviousPage boolean	Confirms if this is the first page of the report. True or false.
hasNextPage boolean	Confirms if this is the last page of the report. True or false.
registrationId string	ID of a webhook registration.
requestId string	GUID that accompanies every request.
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.
isActive boolean	Returns if a webhook is active. True or False.
deactivatedAt date	Returns the date and time a webhook was deactivated.
isInErrorState boolean	Returns if a webhook is in an error status. True or 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.