Skip to main content
POST
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Links a customer to an integration, specifying which external entity (e.g. Stripe customer ID) the customer maps to. syncedEntityId is required on creation, though the same field can read back as null on other integration links that have not yet synced.

id
string
required

The internal ID of the integration this record is linked to

Maximum string length: 255
vendorIdentifier
enum<string>
required

The vendor identifier of the integration (e.g. STRIPE, SALESFORCE, SNOWFLAKE)

Available options:
AUTH0,
ZUORA,
STRIPE,
HUBSPOT,
AWS_MARKETPLACE,
SNOWFLAKE,
SALESFORCE,
BIG_QUERY,
OPEN_FGA,
APP_STORE,
RECEIVED,
PREQUEL,
AIRWALLEX,
STRIPE_INVOICING
syncedEntityId
string
required

The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link.

Maximum string length: 255

Response

The created customer integration object.

Response object

data
CustomerIntegration · object
required

Links this customer to their record in a specific configured integration (e.g. their Stripe customer ID under your Stripe integration). A customer has at most one link per integration.