Connect Slack
Get notifications on spec changes, recipe failures, breaking changes, and member activity.
The Slack integration posts notifications into a channel of your choice when things happen in your workspace. It’s how you keep API stakeholders in the loop without forcing them into the editor.
Connecting
From workspace settings → Integrations, click Connect next to Slack. You’ll be redirected to Slack’s OAuth screen. Approve the scopes:
channels:read— list channels you can post to.chat:write— post messages.users:read— surface usernames in event messages.
After approval, Slack shows as Connected and the Channel selector appears.
Picking a channel
In the connected state, choose:
- Channel — public or private channels you’re a member of. Private channels require inviting
@OpenAPI Studioto that channel first.
Event types
Toggle which events post to Slack:
| Event | Description |
|---|---|
| Spec changes | Path added, removed, or modified |
| Recipe failures | Assertion fail, timeout, or non-2xx response in a recipe run |
| Member activity | New members, role changes |
| Breaking changes | Path removal or response schema change that could break consumers |
You can pick any combination — most teams start with Spec changes + Recipe failures.
Test message
The config panel has a Send test button — fire a sample notification to confirm the channel is reachable before relying on real events.
Message format
Notifications include the workspace and spec name, the actor (who made the change), a short summary, and a deep link back to the editor at the affected operation. Breaking-change messages are highlighted with a red sidebar.
Disconnecting
Workspace settings → Integrations → Slack → Disconnect. The OAuth token is revoked. Any in-flight notifications are dropped.