Skip to main content

​
Integrations API

Integrations APIs cover discovery, installation, provider connectivity, and webhook automation.

​
Authentication model by route family

  • /integrations, /integrations/installed, /integrations/outbound, provider connect/settings: workspace auth + permissions.
  • /integrations/webhooks/{provider}: provider-signed inbound callbacks (no workspace session auth).
  • /integrations/shopify/pixel: public tracking endpoint.

​
Endpoint matrix

​
Catalog

  • GET /integrations
  • GET /integrations/:slug

​
Installed integrations

  • GET /integrations/installed
  • POST /integrations/installed
  • GET /integrations/installed/:id
  • PATCH /integrations/installed/:id
  • DELETE /integrations/installed/:id
  • PATCH /integrations/installed/:id/webhook-events
  • GET /integrations/installed/:id/events

​
Provider connect/settings

  • Slack: /integrations/slack/connect, /integrations/slack/callback
  • HubSpot: /integrations/hubspot/connect, /integrations/hubspot/callback, /integrations/hubspot/settings
  • Stripe: /integrations/stripe/connect, /integrations/stripe/callback, /integrations/stripe/status, /integrations/stripe/settings, /integrations/stripe/disconnect

​
Outbound automation hooks

  • GET /integrations/outbound
  • GET /integrations/outbound/events
  • POST /integrations/outbound
  • GET /integrations/outbound/:id
  • PATCH /integrations/outbound/:id
  • DELETE /integrations/outbound/:id
  • POST /integrations/outbound/:id/test
  • GET /integrations/outbound/:id/deliveries

​
Provider webhook receivers

  • /integrations/webhooks/stripe
  • /integrations/webhooks/shopify
  • /integrations/webhooks/hubspot
  • /integrations/webhooks/slack/*
  • /integrations/webhooks/zapier/*

​
Permission and feature gates

  • Read/list operations require integrations:read or webhooks:read.
  • Mutating install/settings operations require integrations:manage.
  • Outbound webhook mutations require webhooks:manage.
  • Integration installation/update/delete is gated by integrations entitlement.

​
Status model

Installed integrations use lifecycle states such as:
  • active
  • paused
  • error
  • disconnected

​
Typical failures

  • 403 missing permission or feature entitlement
  • 404 unknown integration slug/install ID
  • provider callback/signature validation failures on inbound routes
  • connectivity/provider API failures on OAuth/setup steps
Related docs:
  • /api-reference/integrations/catalog-installed-outbound
  • /api-reference/integrations/provider-connect-and-settings
  • /api-reference/integrations/inbound-webhook-receivers
  • /user-guides/manual/ecosystem/integrations-and-automation
  • /user-guides/manual/ecosystem/workspace-integrations-reference
  • /user-guides/manual/ecosystem/integrations-and-webhooks-reference