Skip to main content

Slack

Overview​

This integration enables Orbb to send notifications, create channels and direct messages, and analyze communication signals across your Slack workspace. The integration uses OAuth2 authentication to securely connect to your workspace and provide comprehensive access to channels, direct messages, users, and messaging capabilities.

Prerequisites​

  • A Slack workspace where you have administrative privileges
  • Permission to authorize OAuth2 applications in your workspace
caution

Only users with administrative privileges can perform these actions. Ensure you have the necessary permissions before proceeding.

OAuth Scopes​

The following OAuth scopes are required for the integration to function properly:

app_mentions:read
assistant:write
channels:history
channels:manage
channels:read
channels:write.invites
chat:write
chat:write.customize
commands
files:read
groups:history
groups:read
groups:write
groups:write.invites
groups:write.topic
im:history
im:read
im:write
im:write.topic
links:read
metadata.message:read
mpim:history
mpim:read
mpim:write
mpim:write.topic
reactions:read
reactions:write
reminders:read
reminders:write
search:read.users
users:read
users:read.email
users:write
OAuth Scopes Explanation

Here's what each scope enables:

  • Public channel scopes:

    • channels:read: View basic information about public channels.
    • channels:history: View messages and other content in public channels.
    • channels:manage: Create, archive, rename, and configure public channels.
    • channels:write.invites: Invite users to public channels.

  • Private channel scopes:

    • groups:read: View basic information about private channels.
    • groups:history: View messages and other content in private channels.
    • groups:write: Create and configure private channels.
    • groups:write.invites: Invite users to private channels.
    • groups:write.topic: Set the topic of private channels.

  • Direct message scopes:

    • im:read: View basic information about 1:1 direct messages.
    • im:history: View messages in 1:1 direct messages.
    • im:write: Start 1:1 direct messages with users.
    • im:write.topic: Set the topic of 1:1 direct messages.

  • Group direct message scopes:

    • mpim:read: View basic information about group direct messages.
    • mpim:history: View messages in group direct messages.
    • mpim:write: Start group direct messages with multiple users.
    • mpim:write.topic: Set the topic of group direct messages.

  • Messaging scopes:

    • chat:write: Post messages as the app.
    • chat:write.customize: Customize the app's messages (username, icon).

  • Interactivity scopes:

    • commands: Add and respond to slash commands.
    • app_mentions:read: Receive notifications when the app is @-mentioned.
    • assistant:write: Use Slack AI Assistant features (suggested actions, prompts).
    • links:read: Receive link-unfurling events for Orbb-recognized URLs.

  • Reaction scopes:

    • reactions:read: View emoji reactions and their users.
    • reactions:write: Add and remove emoji reactions.

  • Reminder scopes:

    • reminders:read: View reminders.
    • reminders:write: Create and manage reminders.

  • File scopes:

    • files:read: View files shared in the workspace.

  • User scopes:

    • users:read: View basic information about workspace users.
    • users:read.email: View email addresses of workspace users.
    • users:write: Edit user profile information (e.g., status).
    • search:read.users: Search for users in the workspace.

  • Message metadata scopes:

    • metadata.message:read: Read message metadata fields (custom event types attached by other apps).

Integration Steps​

1. Start OAuth2 Authorization​

  1. In your Orbb dashboard, navigate to the Integrations section
  2. Select Slack from the available integrations
  3. Click Connect with Slack
  4. You will be redirected to Slack's authorization page

2. Authorize Orbb​

  1. Review the requested permissions (scopes)
  2. Click Allow to authorize Orbb
  3. You will be redirected back to Orbb with the integration configured
tip

After authorization is complete, you can test the integration by sending a test notification to ensure everything is working correctly.

Security Considerations​

  • The OAuth2 connection is secure and can be revoked at any time from your Slack workspace settings
  • Regularly review the integration's access and permissions in your Slack workspace
  • Monitor the integration's usage through Slack's admin dashboard

Troubleshooting​

If you encounter any issues:

  1. Verify that the OAuth2 authorization was successful
  2. Check if the integration has been added to the channels where you expect notifications
  3. Ensure your Slack workspace settings allow external integrations
  4. Try disconnecting and reconnecting the integration if issues persist