Webhooks
Card payments

Update webhook registrations

1min

Updates the web address (URL) for webhooks you are registered to.

Updates the web address (URL) for webhooks you are registered to according to your registration ID
PUT
Request
Response
Body Parameters
registrationId
String
required
Unique registration ID for a webhook
requestID
String
optional
The GUID that enables the application to link request with response
callBackUrl
String
optional
The value is a URL. Webhooks are reported to this URL as a result of a triggered action. Make sure the callback URL is added to CR's allowlist. SSL required.
callBackUserName
String
optional
Authentication data for webhook API calls if the server requires authentication
callBackPassword
String
optional
Authentication data for webhook API calls if the server requires authentication
merchantId
String
optional
Identifier of the merchant partner
IsActive
Boolean
optional
True if it is active, otherwise false
deactivatedAt
String
optional
Returns the date and time a webhook was deactivated. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
isInErrorState
Boolean
optional
True if the webhook is in error status, otherwise false
errorStateReason
String
optional
Reason the registration is in an error state
detectedErrorStateAt
String
optional
The moment that an error was detected. This is important information when troubleshooting a problem.. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]