Skip to main content
POST
Create an integration and its connect link

Authorizations

Authorization
string
header
required

Session token as Authorization: Bearer (the CLI and scripts).

Path Parameters

orgSlug
string
required
workspaceSlug
string
required

Body

application/json
provider
enum<string>
required
Available options:
the_trade_desk,
amazon_dsp,
walmart_dsp,
beeswax,
google_dv360,
openx,
google_ad_manager,
google_ads,
meta,
tiktok,
snapchat,
x,
reddit,
openai_ads,
roku,
iqm,
yahoo_dsp,
mediamath,
linkedin,
pinterest
name
string
required
Required string length: 1 - 100
settings
object

Non-secret provider configuration, validated against the provider's settings fields: GET /v1/integrations/providers/{provider} lists them, and the <Provider>Settings schemas describe each shipped provider

returnUrl
string

Where the client is sent after authorizing; https (http on loopback in development)

Maximum string length: 2048

Connect-link lifetime, default 7

Required range: 1 <= x <= 30

Response

Created

id
string<uuid>
required
workspaceId
string
required
provider
string
required
Example:

"google_ads"

providerName
string
required
Example:

"Google Ads"

category
enum<string> | null
required
Available options:
dsp,
ssp,
wg,
null
authMethod
enum<string> | null
required
Available options:
oauth,
credentials,
null
name
string
required
Example:

"Acme Google Ads"

status
enum<string>
required
Available options:
pending,
active,
error,
disabled
statusDetail
string | null
required

Why the status is error

statusCheckedAt
string | null
required
lastError
string | null
required

Last transient failure, if any

lastErrorAt
string | null
required
settings
object
required

Non-secret provider configuration, validated against the provider's settings fields: GET /v1/integrations/providers/{provider} lists them, and the <Provider>Settings schemas describe each shipped provider

connectedAt
string | null
required
connectedAccount
string | null
required

The external account that authorized access

returnUrl
string | null
required

The live connect link; null when none was issued or it was used

createdByEmail
string | null
required
createdAt
string
required
updatedAt
string
required
connectUrl
string
required

The connect link for the client (also in connectLink.connectUrl)

Example:

"https://portal.example.com/connect/…"