Subscriptions

​

Prerequisites

• Your CDP API Key ID and secret
• A webhook notification HTTPS URL
• Install the CDP CLI and run cdp env live --key-file ./cdp_api_key.json once to configure credentials.

​

1. Review the configuration

• target.url should be your webhook endpoint that will receive the events
• You can also set a headers object in target if your url requires specific headers. Pass it inline with 'target.headers:={"custom-header":"value"}'.
• Include all Transfer event types to receive every notification CDP sends for a transfer. Intermediate events (quoted, processing) are best-effort and can be skipped, but final events (completed, failed) are always sent; see Event delivery. The event types are:

​

2. Subscribe

cdp data webhooks subscriptions create \
  description="CDP Transfers webhook" \
  'eventTypes:=["payments.transfers.quoted","payments.transfers.processing","payments.transfers.completed","payments.transfers.failed"]' \
  target.url=https://your-webhook-url.com \
  'labels:={}' \
  isEnabled:=true

201 Created
{
  "createdAt": "2025-09-10T13:58:38.681893Z",
  "description": "CDP Transfers webhook",
  "eventTypes": [
    "payments.transfers.quoted",
    "payments.transfers.processing",
    "payments.transfers.completed",
    "payments.transfers.failed"
  ],
  "isEnabled": true,
  "labels": {
    "entity": "<YOUR_ENTITY_ID>"
  },
  "secret": "<SECRET_FOR_WEBHOOK_VERIFICATION>",
  "subscriptionId": "<YOUR_SUBSCRIPTION_ID>",
  "target": {
    "url": "https://your-webhook-url.com"
  }
}

​

Manage subscriptions

cdp data webhooks subscriptions list

cdp data webhooks subscriptions get <SUBSCRIPTION_ID>

cdp data webhooks subscriptions update <SUBSCRIPTION_ID> \
  description="Updated: CDP Transfers webhook" \
  'eventTypes:=["payments.transfers.quoted","payments.transfers.processing","payments.transfers.completed","payments.transfers.failed"]' \
  target.url=https://your-new-webhook-url.com \
  'labels:={}' \
  isEnabled:=true

cdp data webhooks subscriptions delete <SUBSCRIPTION_ID>