Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

The Slack integration lets Scrubbe post real-time incident notifications to any channel in your workspace. Once connected, Scrubbe sends a message when an incident is created and another when it is resolved — based on the notification settings in your IMS configuration. You need the ENGINEER role or higher to complete this setup.

​
Connect your Slack workspace

1

Initiate the OAuth flow

Send an authenticated POST request to the Slack connect endpoint. Scrubbe responds with an OAuth authorization URL.
POST /api/v1/integrations/slack/connect
Authorization: Bearer <your-access-token>
Response:
{
  "success": true,
  "message": "Slack OAuth URL generated",
  "data": {
    "url": "https://slack.com/oauth/v2/authorize?client_id=..."
  }
}
2

Authorize in Slack

Open the url returned in the previous step in your browser. Slack will ask you to choose a workspace and grant Scrubbe permission to post messages. After you click Allow, Slack redirects your browser to the Scrubbe callback URL automatically.
3

Scrubbe completes the connection

Scrubbe handles the callback at:
GET /api/v1/integrations/slack/oauth/callback
You do not need to call this endpoint yourself — Slack redirects to it as part of the OAuth handshake. Once the callback completes, your Slack workspace is connected and the integration is stored against your account.
4

Configure notification settings

Update your IMS configuration to control which events trigger Slack messages and which channel Scrubbe posts to.
PUT /api/v1/ims/config
Authorization: Bearer <your-access-token>
Content-Type: application/json

{
  "slackChannel": "#incidents",
  "notifyOnCreate": true,
  "notifyOnResolve": true
}
FieldTypeDescription
slackChannelstringThe Slack channel name (with #) or channel ID to post alerts to.
notifyOnCreatebooleanSend a Slack message when a new incident is created.
notifyOnResolvebooleanSend a Slack message when an incident is resolved.

​
Verify the connection

After completing the OAuth flow, retrieve your integrations to confirm Slack appears as connected: 
GET /api/v1/integrations/{userId}
Authorization: Bearer <your-access-token>
Look for an entry with "provider": "SLACK" and "connected": true in the response.

​
Receive Slack events

If you want Scrubbe to receive events from Slack (such as slash commands or interactive messages), configure your Slack app to send event payloads to the Scrubbe webhook endpoint: 
POST /api/v1/integrations/slack/webhook
This endpoint accepts raw JSON from Slack and does not require an Authorization header — Slack sends its own verification token in the payload instead. Scrubbe validates the token automatically.
You can also initiate the OAuth flow with GET /api/v1/integrations/slack/connect if you prefer to open the authorization URL directly from a browser rather than from an API call.
The slackChannel value must match a channel that the Scrubbe Slack app has been invited to. If Scrubbe does not have access to the channel, notifications will silently fail. Run /invite @Scrubbe inside the channel after completing the OAuth flow.