Get webhooks by ID

GET /api/WebhookRegistrations/{registrationId}

Use this call to get webhook events by {registrationId}.

Query parameters

Parameter	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. Optional
pageSize integer	Number of transactions to list on a page. Optional
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

Response attributes

Attribute	Description
requestId GUID	Unique identifier that accompanies every request.
callBackUrl string	The URL that receives 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	Merchant ID.
isActive boolean	Whether a webhook is active. True if it's active, otherwise false.
deactivatedAt DateTime*	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. Optional
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.

Sample response

{
  "registrationId": "5H6422DF-2FRB-QWR6-3BK9-JF58NXS2M100",
  "requestId": "5Hl422DF-2TQB-Q576-W699-FH1LPPVTB100",
  "callBackUrl": "string",
  "callBackUserName": "string",
  "callBackPassword": "string",
  "merchantId": "848FG57C-620B-NNA8-LEW9-47AKGHA99447",
  "isActive": true,
  "deactivatedAt": "2022-12-16T09:31:35.622Z",
  "isInErrorState": true,
  "errorStateReason": "null",
  "detectedErrorStateAt": "2022-12-16T09:31:35.622Z"
}