Skip to main content

What Cymph uses it for

Cymph connects to Slack to send notifications — when a playbook execution changes state, or when a task is assigned to someone. Messages are posted to a channel you choose. Slack is a notification target only. Cymph does not read your message history, and Slack is neither a content source nor a deployment target — playbooks cannot be deployed to it.

Notification events

All notifications for a single execution are posted as replies in one thread, so a run occupies one conversation in the channel rather than four separate messages.

Requirements

There is no instance URL — Cymph connects to Slack’s API at https://slack.com/api.

App setup

  1. Create a Slack app at api.slack.com/apps for your workspace.
  2. Under OAuth & Permissions, add the bot token scopes listed below.
  3. Install the app to your workspace and copy the Bot User OAuth Token.
  4. Invite the bot to every channel you want Cymph to post in — see the warning below.

Permissions

Add these as Bot Token Scopes: If you only ever post to public channels, groups:read can be omitted — private channels simply will not appear in the picker.
Adding the scopes is not enough on its own: the bot must also be a member of the destination channel. Slack rejects chat.postMessage with not_in_channel for any channel the app has not been invited to, public ones included. In Slack, open the channel and run /invite @YourAppName.
If a notification fails with a scope error, Cymph reports both what your token was granted and what the call required — for example Slack API error: missing_scope (granted: chat:write; accepted: channels:read). That message tells you exactly which scope to add.

What Cymph reads and writes

Channel enumeration covers public and private channels, follows Slack’s pagination to the end, and reads only each channel’s name, ID, privacy flag, membership flag, and member count. Archived channels are filtered out of the picker. Cymph never reads message content and never deletes or edits messages after posting.

Testing the connection

Test Connection calls auth.test and reports:
A successful test confirms the token and its scopes, but not channel membership. If notifications never arrive despite a green test, the bot has almost certainly not been invited to the destination channel.
Per-user email notification preferences are separate and live in Notification settings.