cURL
No Authentication
curl --request POST \ --url https://api.uat.accessrc.org/api/Event/Subscribe \ --header 'Content-Type: application/json-patch+json' \ --header 'x-api-key: <api-key>' \ --data ' { "eventType": "DELIVERY_CHANNEL_STATUS_UPDATED", "callbackUrl": "https://partner.example.com/webhook", "auth": null } '
{ "error": null, "data": { "message": "Webhook successfully subscribed", "subscriptionId": "c79f8f33-0042-4c25-bd5e-0dc1982f8cea", "callbackUrl": "https://partner.example.com/webhook", "eventType": "DELIVERY_REQUEST_SENT", "date": "2025-04-07T07:51:38Z" }, "status": "success" }
API Key required in x-api-key header
x-api-key
Callback URL that will receive the event notifications.
256
Type of event to subscribe to.
NULL
DELIVERY_CHANNEL_STATUS_UPDATED
DELIVERY_REQUEST_SENT
DELIVERY_REFUND_REQUESTED
"NULL"
Show child attributes
Type of authentication to use. Options: 'hmac' (secret key), 'header' (API key), 'basic' (username/password), or null if no authentication is required.
16
Name of the API key header. Required if type is 'header'.
64
Value of the API key. Required if type is 'header'.
512
Username for basic authentication. Required if type is 'basic'.
128
Password for basic authentication. Required if type is 'basic'.
Secret key for HMAC authentication. Required if type is 'hmac'.
OK
