Integrations

Get integration

Changed on

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, the ingestion block naming which lists its contacts join, and prioritized recommendations. Credentials are never returned. Requires the account:read, subscribers:read, sequences:read, and lists:read scopes.

get/integrations/{id}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/integrations/{id}
  • Auth
    HTTP bearer

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
  }
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 37bcc0f4c9d5Revision changes
    • warning

      added the new disconnect enum value to the /////// response property for the response status