Skip to main content
Create and manage webhook subscriptions for transfer lifecycle events.

Prerequisites

You will need:
  • 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

Define which transfer events to receive and where webhooks should be delivered. Important configuration notes:
  • 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"}'.
  • All Transfer event types should be included to ensure you receive notifications for every transfer state change:

2. Subscribe

Create the subscription with the CDP CLI and store the returned subscriptionId and secret.
Sample webhook subscription response:

Manage subscriptions

Use the subscriptionId from the response to view, update, or delete the subscription. List all subscriptions
View specified subscription details by subscription ID
Update subscription update is a full replace — pass every field, including ones you aren’t changing:
Delete subscription