v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Integrations

Get integration

Inspects one connected integration - what the provider syncs, every event it emits, the tags each event applies through the company's sync rules, the sequences that trigger on those events, recent activity, and prioritized recommendations. Credentials are never returned. Requires the account:read, subscribers:read, and sequences:read scopes.

get/integrations/{id}

Path parameters

idstring required

Integration ID.

Response

Integration detail returned

successboolean
unusedEventsstring[]

Events the provider emits that no sequence triggers on.

accountNeverReceivedEventsstring[]

Provider event names the account has never received from any source. Not integration-specific.

availableActionsstring[]

Actions callable right now given the integration's current state.

Example response

{
  "success": true,
  "integration": {
    "provider": "shopify",
    "name": "Shopify",
    "lastSyncSkipped": {
      "records": [
        {
          "reasonCode": "invalid_email_domain",
          "reason": "Invalid domain for \"buyer@example.com\": Domain cannot receive email (no MX records)"
        }
      ]
    }
  },
  "capabilities": {
    "provider": "stripe",
    "name": "Stripe"
  },
  "activity": {
    "windowHours": 24
  }
}