Skip to main content
POST
/
api
/
Event
/
Subscribe
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"
}

Authorizations

​
x-api-key
string
header
required

API Key required in x-api-key header

Body

​
callbackUrl
string<uri>
required

Callback URL that will receive the event notifications.

Maximum string length: 256
​
eventType
enum<string>

Type of event to subscribe to.

Available options:
NULL,
DELIVERY_CHANNEL_STATUS_UPDATED,
DELIVERY_REQUEST_SENT,
DELIVERY_REFUND_REQUESTED
Example:

"NULL"

​
auth
object

Response

OK

​
Error
object
​
Data
object