Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

Set Up OAuth for SlackBeta

Beta
This is coming — this page describes a feature that's still being rolled out and may not be available to you yet.

Register Slack as an OAuth provider so users can authorize Slack workspace access from Haystack Enterprise Platform.

About This Task​

The Slack template uses Slack's OAuth v2 authorize and access endpoints. Slack scopes are bot or user scopes that you configure in the Slack app; the template leaves scopes empty so you can paste the comma-separated list your app publishes.

Prerequisites​

  • Make sure you meet the prerequisites for Configure External Connections.
  • You need permission to create Slack apps in your workspace or Enterprise Grid organization.
Redirect URL

Register the redirect URI from the Redirect URL field in the Add OAuth Provider dialog with your identity provider. Keep the default unless you embed the connect flow in your own frontend.

The callback is served by the deepset API, not the web app. On deepset Cloud, the default is https://api.cloud.deepset.ai/api/v2/connections/callback. On other deployments, use your organization's API base URL with the path /api/v2/connections/callback.

Create a Slack App​

  1. Open Slack API: Your Apps and click Create New App.
  2. Choose From scratch, type an app name, and select the workspace where you develop the app.
  3. Go to OAuth & Permissions.
  4. Under Redirect URLs, click Add New Redirect URL, paste the redirect URI from Haystack Enterprise Platform, and save the URL.
  5. Under Scopes, add the Bot Token Scopes or User Token Scopes your integration needs.
  6. At the top of OAuth & Permissions, copy the Client ID and Client Secret.

For an overview, see Installing with OAuth.

Register the Provider in Haystack Enterprise Platform​

  1. Click your profile icon and choose Settings.
  2. Go to Organization and open Integrations.
  3. In External Connections, click Add OAuth Provider.
  4. Select the Slack template.
  5. Fill in the fields:
    • Provider Type — keep slack unless you register multiple Slack apps.
    • Display Name — for example Slack.
    • Client ID and Client Secret from the Slack app.
    • Authorization URL and Token URL — pre-filled to Slack's OAuth v2 endpoints.
    • Scopes — comma-separated Slack scope names, matching what you added in the Slack app.
  6. Click Create.

What To Do Next​