Delete webhook events
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 | GUID that accompanies every request. |
registrationId | ID of a webhook registration. |
callBackUrl | The URL that will receive messages in return. |
callBackUserName | Authentication data that accompanies webhook API calls if the server requires authentication. |
callBackPassword | Authentication data that accompanies webhook API calls if the server requires authentication. |
merchantId | Unique identifier for the merchant. |
isActive | Returns if a webhook is active. |
deactivatedAt | Returns the date and time a webhook was deactivated. |
isInErrorState | Returns if a webhook is in an error status. |
errorStateReason | Returns the reason that a webhook is in an error status. |
detectedErrorStateAt | The moment that an error was detected. This is important information when troubleshooting a problem. |
Updated 6 months ago