Get webhooks by ID (API)

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
string

ID of a webhook registration.
Required

pageNumber
integer

The current page number determined by the total number of transactions and the number of transactions per page.

pageSize
integer

Number of transactions to list on a page.

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.

hasNextPage
boolean

Whether the search result set includes more data on subsequent pages or not. True if there is more data, false if not.

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

Whether a webhook is active.
True if it's active, otherwise false.

deactivatedAt
date

Returns the date and time a webhook was deactivated.

isInErrorState
boolean

Whether a webhook is in an error state.
True if the webhook is in an error state, otherwise 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.


Did this page help you?