Skip to content

Integration Template

Use this template as the starting point for a new integration page.

Overview

Explain the integration and the outcome it enables.

Prerequisites

  • Account or service access
  • API credentials
  • Environment setup

Setup

  • Create the integration in the provider console.
  • Configure credentials.
  • Test the connection.
  • Enable production traffic.

Events or data flow

Document the sequence of events or data exchange.

Troubleshooting

List the most common failure modes and what to check first.

Notes

  • Keep provider terminology consistent across examples.
  • Show auth details before request or event flow specifics.
  • Prefer short, practical examples over long prose.

Markdown-first documentation for teams that update docs often.