Delete webhook events (API)

DELETE /api/WebhookRegistrations/{registrationId}

Use this call to delete a webhook registration.

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": false,
  "deactivatedAt": "2020-12-16T09:31:35.617Z",
  "isInErrorState": true,
  "errorStateReason": "string",
  "detectedErrorStateAt": "2020-12-16T09:31:35.617Z"
}

Attributes

Attribute

Description

requestId
string

GUID that accompanies every request.
Required

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

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.


Did this page help you?