Skip to main content

Slack

Overview​

This integration enables Orbb to send notifications through Slack, allowing for seamless communication and updates within your organization's Slack workspace. The integration uses OAuth2 authentication to securely connect to your Slack workspace and provide comprehensive access to channels, 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:

channels:read
channels:history
groups:read
groups:history
im:read
im:history
mpim:read
chat:write
chat:write.public
users:read
users:read.email
team:read
files:write
chat:write.customize
app_mentions:read
im:write
reactions:read
reactions:write
OAuth Scopes Explanation

Here's what each scope enables:

  • Channel-related scopes:

    • channels:read: View basic information about public channels
    • channels:history: View messages and other content in public channels
    • groups:read: View basic information about private channels
    • groups:history: View messages and other content in private channels

  • Direct Message scopes:

    • im:read: View basic information about direct messages
    • im:history: View messages in direct messages
    • im:write: Start direct messages with users
    • mpim:read: View information about group direct messages

  • Messaging scopes:

    • chat:write: Send messages as the app
    • chat:write.public: Send messages to channels the app isn't in
    • chat:write.customize: Customize the app's messages
    • files:write: Upload, edit, and delete files

  • User and Team scopes:

    • users:read: View basic information about users
    • users:read.email: View email addresses of users
    • team:read: View basic information about the workspace

  • Interaction scopes:

    • app_mentions:read: Receive notifications when the app is mentioned
    • reactions:read: View emoji reactions and their users
    • reactions:write: Add and remove emoji reactions

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