v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB

Integrations

Create integration

Creates a new integration for the project.

post/integrations

Headers

Idempotency-Keystring

Unique key to ensure idempotent creation. Same key returns original response.

Request body

titlestring required

Display title visible in the dashboard (1-255 chars).

integrationstring required

Provider slug. Call GET /v4/integrations/meta for the canonical catalog; the typical set includes amplitude, appmetrica, facebook, firebase, mixpanel, posthog, segment, searchads, adjust, appsflyer, branch, kochava, singular, split_metrics, asapty, tenjin, amazon_s3, google_cloud_storage, slack, webhooks, braze, clevertap, mailchimp, onesignal, pushwoosh.

target_platform'iOS' | 'Android' | 'Stripe' required

Store to forward events for. Case-sensitive.

Example request

{
  "title": "Amplitude — Production iOS",
  "integration": "amplitude"
}

Response

Integration created.

objectstring required

idstring required

Integration identifier. Stable for the lifetime of the record (soft-deleted records keep their ID).

urlstring required

Canonical API path.

titlestring required

Caller-supplied display title.

integrationstring required

Provider display title (not the lowercase slug used on create). Use for UI; for references in other requests use id.

target_platform'iOS' | 'Android' | 'Stripe' required

Store the integration forwards events for. Case-sensitive.

active0 | 1 | 2 required

Integration state.

0 — paused / draft (no events forwarded).
1 — active (events forwarded).
2 — error (delivery worker suspended the pipeline; inspect last_error_message/last_error_at). Cannot be set by callers.

created_atstring date-time required

ISO 8601 creation timestamp.

updated_atstring date-time required

ISO 8601 last-update timestamp.

last_delivery_atstring date-time nullable required

ISO 8601 timestamp of the most recent successful delivery, or null if never delivered.

last_error_atstring date-time nullable required

ISO 8601 timestamp of the most recent delivery failure, or null.

last_error_messagestring nullable required

Human-readable description of the most recent delivery failure, or null.

delivery_error_countinteger required

Running count of delivery failures since the last successful delivery.

Example response

{
  "object": "integration",
  "id": "gNl6hyM6",
  "url": "/v4/integrations/gNl6hyM6",
  "title": "Amplitude — Production iOS",
  "integration": "Amplitude",
  "created_at": "2026-02-26T16:03:09Z",
  "updated_at": "2026-02-26T16:03:09Z",
  "last_delivery_at": "2026-04-22T10:12:33Z"
}