CDPGuidesSupport

Sources

Manage data collection sources. Create, list, update, and delete sources in your Ours Privacy account, including pixel tokens and install scripts.

Manage data collection sources. Create, list, update, and delete sources in your account.

Where this fits in the dispatch flow

Sources are the entry point:

Configuration changes at any stage take effect once you publish a new version.

Events leave a source and are evaluated against Allowed Events (does the event name match an allow-list entry?), then Data Governance (do any consent rules stop dispatch?), then per-destination Mappings (which fields go where?), before reaching the configured destinations.

Operational fields

Every source response includes isPublished: whether this source is included in the currently published version. A source accepts inbound events once it is published.

To confirm events are flowing, call destination health for a destination that receives this source's events: a non-zero successCount means events are arriving and being delivered.

PATCH semantics

PATCH /rest/v1/sources/{id} is a partial update. Fields you omit are left unchanged. Send explicit null to clear a nullable field (e.g. "redirectUrl": null). The response returns the full source entity after the update.

Source tokens (/tokens)

GET /rest/v1/sources/{id}/tokens returns different shapes depending on the source type:

Pixel sources (WebSource, PixelImage, HTTPApiSource, and similar) return:

{
  "sourceType": "pixel",
  "token": "...",
  "testToken": "...",
  "installScript": "<script>...</script>",
  "testInstallScript": "<script>...</script>"
}

Webhook sources (Webhook, CallRail, Formstack, Healthie, TypeformWebhooks, JotFormWebhooks, CalendlyWebhook, WhatConverts, HubspotAppActions, and all other *Webhook types) return:

{
  "sourceType": "webhook",
  "token": "...",
  "testToken": "...",
  "ingestUrl": "https://api.oursprivacy.com/source/...",
  "testIngestUrl": "https://api.oursprivacy.com/source/...",
  "sampleCurl": "curl -X POST 'https://api.oursprivacy.com/source/...' ..."
}

Use the sourceType field to discriminate between the two response shapes. Webhook sources do not have an installScript; pixel sources do not have an ingestUrl.

Building webhook mappers

Webhook sources accept arbitrary JSON payloads. You can map those inbound fields to Ours Privacy event names and properties using the Mappings API with entityId set to the source id and templateId set to "webhook" (or the relevant per-vendor template such as "typeform", "jotform", "calendly", etc.).

To discover the exact JSON structure your webhook is sending, send a test request and inspect the recent payloads in the platform dashboard.

GET/rest/v1/sources

GET
/rest/v1/sources
AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

limit?|

Maximum number of sources to return. Defaults to 25; values below 1 are clamped to 1 and values above 200 are clamped to 200.

cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

type?string

Filter by source type.

Value in

  • "AlchemerWebhook"
  • "AndroidNativeApi"
  • "Branch"
  • "CSharpApi"
  • "CalComWebhooks"
  • "CalendlyWebhook"
  • "CallRail"
  • "CallTrackingMetrics"
  • "DotNetApi"
  • "FacebookLeadAds"
  • "FlutterApi"
  • "FormsortWebhooks"
  • "Formstack"
  • "GoLangApi"
  • "HTTPApiSource"
  • "Healthie"
  • "Heyflow"
  • "HubspotAppActions"
  • "HubspotFormWebhook"
  • "JotFormWebhooks"
  • "KotlinApi"
  • "NodejsApi"
  • "PHPApi"
  • "PixelImage"
  • "PythonApi"
  • "ReactNativeApi"
  • "RedirectSource"
  • "RubyApi"
  • "SegmentWebPlugin"
  • "TypeformWebhooks"
  • "WebSource"
  • "Webhook"
  • "WhatConverts"
  • "iOSNativeApi"
status?string

Filter by source status.

Value in

  • "Disabled"
  • "Enabled"
nameContains?string

Case-insensitive substring filter on the source name.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/sources"
{  "entities": [    {      "settings": {},      "id": "string",      "name": "string",      "type": "AlchemerWebhook",      "status": "Disabled",      "createdAt": "string",      "accountId": "string",      "isPublished": true,      "selectedAccountId": "string",      "whitelistDomains": [        "string"      ],      "whitelistIps": [        "string"      ],      "botControlMode": "Allow",      "botScoreThreshold": 0,      "excludeRequestContext": true,      "redirectUrl": "string",      "forwardUtmToDestination": true,      "projectAPIKey": "string",      "probabilisticIdentity": {        "enabled": true,        "matchWindowMinutes": 0,        "maxMatchesPerIp": 0      }    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}

POST/rest/v1/sources

POST
/rest/v1/sources
*object
AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/rest/v1/sources" \  -H "Content-Type: application/json" \  -d '{    "type": "AlchemerWebhook"  }'
{  "settings": {},  "id": "string",  "name": "string",  "type": "AlchemerWebhook",  "status": "Disabled",  "createdAt": "string",  "accountId": "string",  "isPublished": true,  "selectedAccountId": "string",  "whitelistDomains": [    "string"  ],  "whitelistIps": [    "string"  ],  "botControlMode": "Allow",  "botScoreThreshold": 0,  "excludeRequestContext": true,  "redirectUrl": "string",  "forwardUtmToDestination": true,  "projectAPIKey": "string",  "probabilisticIdentity": {    "enabled": true,    "matchWindowMinutes": 0,    "maxMatchesPerIp": 0  }}

GET/rest/v1/sources/{id}

GET
/rest/v1/sources/{id}
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/sources/string"
{  "settings": {},  "id": "string",  "name": "string",  "type": "AlchemerWebhook",  "status": "Disabled",  "createdAt": "string",  "accountId": "string",  "isPublished": true,  "selectedAccountId": "string",  "whitelistDomains": [    "string"  ],  "whitelistIps": [    "string"  ],  "botControlMode": "Allow",  "botScoreThreshold": 0,  "excludeRequestContext": true,  "redirectUrl": "string",  "forwardUtmToDestination": true,  "projectAPIKey": "string",  "probabilisticIdentity": {    "enabled": true,    "matchWindowMinutes": 0,    "maxMatchesPerIp": 0  }}

PATCH/rest/v1/sources/{id}

PATCH
/rest/v1/sources/{id}
*object
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/rest/v1/sources/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "settings": {},  "id": "string",  "name": "string",  "type": "AlchemerWebhook",  "status": "Disabled",  "createdAt": "string",  "accountId": "string",  "isPublished": true,  "selectedAccountId": "string",  "whitelistDomains": [    "string"  ],  "whitelistIps": [    "string"  ],  "botControlMode": "Allow",  "botScoreThreshold": 0,  "excludeRequestContext": true,  "redirectUrl": "string",  "forwardUtmToDestination": true,  "projectAPIKey": "string",  "probabilisticIdentity": {    "enabled": true,    "matchWindowMinutes": 0,    "maxMatchesPerIp": 0  }}

DELETE/rest/v1/sources/{id}

DELETE
/rest/v1/sources/{id}
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/rest/v1/sources/string"
{  "deleted": true}

GET/rest/v1/sources/{id}/tokens

GET
/rest/v1/sources/{id}/tokens
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/sources/string/tokens"
{  "sourceType": "pixel",  "token": "string",  "testToken": "string",  "installScript": "string",  "testInstallScript": "string"}

How is this guide?