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
required
String
Unique registration ID for a webhook
requestID
optional
String
The GUID that enables the application to link request with response
callBackUrl
optional
String
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
optional
String
Authentication data for webhook API calls if the server requires authentication
callBackPassword
optional
String
Authentication data for webhook API calls if the server requires authentication
merchantId
optional
String
Identifier of the merchant partner
IsActive
optional
Boolean
True if it is active, otherwise false
deactivatedAt
optional
String
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
optional
Boolean
True if the webhook is in error status, otherwise false
errorStateReason
optional
String
Reason the registration is in an error state
detectedErrorStateAt
optional
String
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]
Updated 29 Jan 2025
Did this page help you?