Skip to main content
POST
Create a CDP destination subscription

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required
Maximum string length: 120
target_url
string
required

HTTPS endpoint, or nango://<destination> for Nango-routed destinations.

event_types
string[]
required
Required array length: 1 - 64 elements
destination
string
default:webhook

Destination kind (e.g. webhook, salesforce, braze, hubspot); defaults to webhook.

config
object
filter_predicate
object | null

Optional AND-of-comparisons predicate; events that do not match are dropped before dispatch.

sampling_rate
null | number

Optional Bernoulli sampling rate in [0, 1]; null delivers every event.

Required range: 0 <= x <= 1

Optional per-subscription consent channel to gate delivery on the contact's consent.

Response

200 - application/json

The created subscription plus a one-time plaintext signing secret.

data
object

A CDP destination subscription — its delivery target, event filter/sampling settings and current circuit-breaker health. The signing secret is never returned in full; secret_suffix exposes only the last four characters for visual diffing across rotations.

meta
object