Register for webhook events

POST /api/WebhookRegistrations

This call registers you to webhook events.

Request attributes

Attribute	Description
registrationId string	ID of a webhook registration.
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	True if a webhook is 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.
errorStateReason string	Returns the reason that a webhook is in an error status.
detectedErrorStateAt DateTime	The moment that an error was detected. This is important information when troubleshooting a problem.

Sample request POST /api/WebhookRegistrations

{
  "registrationId": "7CJ39SA3DC-FA3B-4462-5HC9-FJL532ASLGF0",
  "requestId": "R4J39QO2DC-YP3B-3BT2-5AC9-FFOP111SLGN0",
  "callBackUrl": "string",
  "callBackUserName": "string",
  "callBackPassword": "string",
  "merchantId": "2BGA9552DC-6B3B-C892-5AR9-SJB902FFLB0O",
  "isActive": true,
  "deactivatedAt": "2022-12-16T09:31:35.611Z",
  "isInErrorState": true,
  "errorStateReason": "string",
  "detectedErrorStateAt": "2022-12-16T09:31:35.611Z"
}