Skip to main content

UpdateWebhookSubscriptionRequest

webhook_urlstring

New webhook URL (optional). Only update if provided.

Possible values: <= 500 characters, Value must match regular expression ^https?://.*

Example: https://api.example.com/webhooks/rcm-events-v2
subscribed_event_typesstring[]
auth_typestring

How RCM authenticates each delivery to your endpoint. HMAC (the default) signs the delivery with a secret RCM generates and stores per subscription — you verify the X-RCM-Signature header. BASIC sends an Authorization: Basic base64(client_id:client_secret) header built from credentials you supply.

Possible values: [HMAC, BASIC]

Default value: HMAC
Example: BASIC
basic_auth_client_idstring

Client ID for HTTP Basic authentication. Required when auth_type is BASIC, ignored otherwise.

Possible values: <= 255 characters

Example: red-de-oro-client
descriptionstring

Possible values: <= 500 characters

custom_headers object
property name*string
metadata object
property name*object