Skip to main content
POST
Create a custom connector

Authorizations

Authorization
string
header
required

Pass your pk_live_... API key as a Bearer token.

Body

application/json
name
string
required
source_name
string
required
accepted_kinds
string[] | null

First-party event kinds this connector may emit. Empty/None = all kinds allowed.

metadata
Metadata · object | null

Key/value metadata applied to every event from this connector. String values only.

Example:

Response

Successful Response

Returned on creation. Auth for ingest is via platform API keys (pk_live_…); call /v1/custom-connectors/{connector_id}/ingest… with Authorization: Bearer pk_live_… to push data.

connector_id
string
required

Unique identifier for the connector.

Example:

"c0ffee01-1234-5678-90ab-cdef01234567"

name
string
required

Human display name.

Example:

"Acme CRM"

source_name
string
required

Immutable slug used in the event source (custom:<source_name>).

Example:

"acme-crm"

created_at
string
required

ISO 8601 creation timestamp.

created_by
CreatedBy · object
required

Principal that created a resource. id is a user_id for type="user" and a key_id (UUID) for type="api_key".

is_active
boolean
required

False once the connector has been deactivated.

accepted_kinds
string[]

First-party event kinds this connector may emit. Empty = all kinds allowed.

Example:
metadata
Metadata · object | null

Key/value metadata applied to every event from this connector. String values only. Per-item metadata on ingest overrides on key conflict.

Example: