DELETE /api/WebhookRegistrations/{registrationId}

Use this call to delete a webhook registration.

Response Attributes

Attribute	Description
requestId GUID	Unique identifier that accompanies every request.
registrationId string	ID of a webhook registration.
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	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 a webhook is in an error status, otherwise 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 response DELETE /api/WebhookRegistrations/{registrationId}

{
  "registrationId": "7JH255GC-XQ1B-HOT5-66V6-6GFH427HHFN0",
  "requestId": "JALH5FDC-GA3B-HAG5-0DB1-FJO6SN2OB1G0",
  "callBackUrl": "string",
  "callBackUserName": "string",
  "callBackPassword": "string",
  "merchantId": "7FLAH55C-2GAB-HSS5-AGH9-AGHHE6WD6400",
  "isActive": false,
  "deactivatedAt": "2022-12-16T09:31:35.617Z",
  "isInErrorState": true,
  "errorStateReason": "string",
  "detectedErrorStateAt": "2022-12-16T09:31:35.617Z"
}