Docs / Integration API contract

Integration API contract

What a Slack-shaped app, webhook or bot can rely on from an OwnBase server, and where it differs from Slack.

This is what a Slack-shaped integration can rely on from this server, and where it differs from Slack. It is deliberately narrower than Slack's platform: the aim is that the common integrations — a webhook that posts, a bot that answers a slash command or a button, an app that listens for events — work by changing the URL they talk to, and that everything else fails with a name rather than quietly.

The tables marked checked below are read by packages/server/test/integrationContract.test.ts, which fails if they stop matching the server. Everything else here was confirmed against a running server when written.

Sections

This page is made from docs/INTEGRATIONS.md.