GuidesSupport
DocumentationCookie ConsentMapsTag ManagerTranslation WidgetHeatmapsPlatformIngest

Sources

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

GET
/rest/v1/sources

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/sources"
{
  "entities": [
    {
      "id": "string",
      "name": "string",
      "type": "AlchemerWebhook",
      "status": "Disabled",
      "createdAt": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
POST
/rest/v1/sources

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Request Body

application/json

name?|
type*string
Value in"AlchemerWebhook" | "AndroidNativeApi" | "CSharpApi" | "CalComWebhooks" | "CalendlyWebhook" | "CallRail" | "CallTrackingMetrics" | "DotNetApi" | "FacebookLeadAds" | "FormsortWebhooks" | "Formstack" | "GoLangApi" | "HTTPApiSource" | "Healthie" | "HubspotAppActions" | "HubspotFormWebhook" | "JotFormWebhooks" | "KotlinApi" | "NodejsApi" | "PHPApi" | "PixelImage" | "PythonApi" | "ReactNativeApi" | "RedirectSource" | "RubyApi" | "SegmentWebPlugin" | "TypeformWebhooks" | "WebSource" | "Webhook" | "WhatConverts" | "iOSNativeApi"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.oursprivacy.com/rest/v1/sources" \  -H "Content-Type: application/json" \  -d '{    "type": "AlchemerWebhook"  }'
{
  "id": "string",
  "name": "string",
  "type": "AlchemerWebhook",
  "status": "Disabled",
  "createdAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/sources/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization 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://app.oursprivacy.com/rest/v1/sources/string"
{
  "id": "string",
  "name": "string",
  "type": "AlchemerWebhook",
  "status": "Disabled",
  "createdAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
PATCH
/rest/v1/sources/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Request Body

application/json

status*string
Value in"Disabled" | "Enabled"
botControlMode?|
Value in"Allow" | "Block"
excludeRequestContext?|
name?|
projectAPIKey?|
redirectUrl?|
selectedAccountId?|
whitelistDomains?array<>|
whitelistIps?array<>|

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.oursprivacy.com/rest/v1/sources/string" \  -H "Content-Type: application/json" \  -d '{    "status": "Disabled"  }'
{
  "id": "string",
  "name": "string",
  "type": "AlchemerWebhook",
  "status": "Disabled",
  "createdAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
DELETE
/rest/v1/sources/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization 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://app.oursprivacy.com/rest/v1/sources/string"
true
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}

How is this guide?

Destinations

Previous Page

Allowed Events

Next Page