Skip to main content

​
Catalog, Installed, and Outbound Integrations

This module covers workspace-managed integration records and outbound automation hooks.

​
Catalog endpoints

  • GET /api/integrations
  • GET /api/integrations/:slug
Catalog only returns active, verified global integrations and merges installation status for the current workspace.

​
Installed integration endpoints

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

​
Installation behavior

  • Install routes are workspace-scoped.
  • Create routes generate integration installation records and per-install webhook secrets.
  • Sensitive fields are masked in most responses and only shown at creation points when required.

​
Outbound webhook automation endpoints

  • GET /api/integrations/outbound
  • GET /api/integrations/outbound/events
  • POST /api/integrations/outbound
  • GET /api/integrations/outbound/:id
  • PATCH /api/integrations/outbound/:id
  • DELETE /api/integrations/outbound/:id
  • POST /api/integrations/outbound/:id/test
  • GET /api/integrations/outbound/:id/deliveries
Supported outbound event names include link, lead/sale, partner/enrollment, commission, bounty, and payout lifecycle events.

​
Permissions and feature gates

  • Read routes: integrations:read or webhooks:read (route-specific).
  • Mutations: integrations:manage or webhooks:manage.
  • Install/update/delete and outbound create/update/delete are gated by integrations entitlement.

​
Typical failures

  • 403 permission or feature gate denial
  • 404 unknown integration/install/outbound ID in workspace scope
  • 409 duplicate installation or webhook URL constraints
  • 400 validation issues (events, settings, URL format)