Providing ready to go integrations with other APIs has become commonplace as part of Software as a Service (SaaS) solutions, and help demonstrate the value an API provides. Demonstrating how an API can be used with the existing platforms that API consumers are already using help make your APIs more useful and sticky for developers.

Also known as: Connectors, Integration Catalog, Partner Integrations

Example

- type: Integrations
  url: https://developers.example.com/integrations

Standards

• OpenAPI Initiative OpenAPI Specification 3.1
• AsyncAPI Initiative AsyncAPI Specification
• IETF RFC 6749 — OAuth 2.0 (scopes for partner access)
• Community standard Standard Webhooks
• CNCF CloudEvents 1.0
• OpenAPI Initiative Arazzo Specification

Media Types

• application/json — Catalog metadata and integration manifests.
• application/yaml — OpenAPI, AsyncAPI, and Arazzo descriptions backing integrations.
• application/cloudevents+json — CloudEvents structured-mode payloads for event-driven integrations.

OpenAPI Expression

• servers (OpenAPI 3.x) — Distinct base URLs per integration environment (sandbox, partner, prod).
• components.securitySchemes (OpenAPI 3.x) — OAuth 2.0 and API-key schemes consumed by integration platforms.
• webhooks (OpenAPI 3.1) — Outbound webhook contracts exposed to integration partners.

Governance Rules

• operation-operationId (Spectral built-in) — Stable operationIds are required for generated connectors and iPaaS bindings.
• oas-security-defined (Spectral built-in) — Every operation must declare a security scheme partners can wire up.

Risk & Compliance

Security: Partner integrations multiply the attack surface; require least-privilege OAuth scopes, per-partner secrets, signed webhooks (Standard Webhooks), and revocable credentials. Document data-handling expectations for downstream platforms.

Tools

• Zapier developer platform — iPaaS
• Make — iPaaS
• Pipedream — iPaaS / workflow
• n8n — Self-hostable workflow automation (Sustainable Use License)
• OpenAPI Generator — Client / connector generation (Apache-2.0)
• Workato — Enterprise iPaaS

Suggested Metrics

• active_integrations — Count of active partner integrations in the catalog.
• integration_install_count — Number of times each integration is enabled by an end user.
• webhook_delivery_success_rate — Share of outbound webhook attempts acknowledged with 2xx.
• partner_token_refresh_failures — Failed OAuth refresh attempts per partner; indicates rotation problems.

Example Implementations

• Zapier — Developer platform for building published Zapier integrations.
• Slack — OAuth scopes and Events API webhooks consumed by integration platforms.
• Stripe — Connect, webhooks, and the Stripe App platform power third-party integrations.
• HubSpot — Marketplace apps and OAuth-scoped partner integrations.

Related Properties

• Openapi
• Asyncapi
• Webhooks
• Authentication
• Partners
• Sdks

Tags

• Integrations
• Interoperability

All Common Properties