> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Slack

> Integrate your application with the Slack API

## 🚀 Quickstart

Connect to Slack with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Slack*.
  </Step>

  <Step title="Authorize Slack">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Slack. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the Slack API">
    Let's make your first request to the Slack API (fetch a list of channels in a Slack team). Replace the placeholders below with your [Environment API key](/docs/reference/backend/http-api/api-keys), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/conversations.list?limit=10" \
          -H "Authorization: Bearer <NANGO-API-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

        const res = await nango.get({
            endpoint: '/conversations.list',
            params: { limit: 10 },
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/docs/reference/backend/backend-sdk/node#get-a-connection-with-credentials) or [API](/docs/reference/backend/http-api/connections/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/docs/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Slack Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Slack OAuth app](/docs/api-integrations/slack/how-to-register-your-own-slack-api-oauth-app)\
  Register an OAuth app with Slack and obtain credentials to connect it to Nango

* [How to setup webhooks with Slack on Nango](/docs/api-integrations/slack/webhooks)\
  Set up Slack Events API webhooks to receive real-time workspace events

* [Slack user access tokens in Nango](/docs/api-integrations/slack/slack-user-access-tokens)\
  How to get, and use, Slack user access tokens with Nango

Official docs: [Slack API docs](https://api.slack.com/web)

## 🧩 Pre-built syncs & actions for Slack

Explore Nango-provided actions in your dashboard. Extend and customize them to fit your needs.

### Channels

| Function name | Description | Type | Source code |
| - | - | - | - |
| `channels` | Sync conversations allowed by granted scopes - public/private channels, DMs, and group DMs | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/syncs/channels.ts) |

### Messages

| Function name | Description | Type | Source code |
| - | - | - | - |
| `messages-received` | Sync messages, thread replies, and reactions for conversations the bot can access; fully backfill new channels, then resync the last 10 days using channelsLastSyncDate metadata. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/syncs/messages-received.ts) |

### Users

| Function name | Description | Type | Source code |
| - | - | - | - |
| `users` | Sync all workspace users including deactivated accounts with email and profile fields | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/syncs/users.ts) |

### Others

| Function name | Description | Type | Source code |
| - | - | - | - |
| `add-reaction` | Add an emoji reaction to a specific Slack message | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/add-reaction.ts) |
| `archive-channel` | Archive a Slack channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/archive-channel.ts) |
| `create-channel` | Create a new public or private Slack channel by name; does not create DMs or other conversation types. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/create-channel.ts) |
| `create-reminder` | Create a reminder for a user | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/create-reminder.ts) |
| `delete-message` | Delete a message from a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/delete-message.ts) |
| `delete-scheduled-message` | Cancel a scheduled message | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/delete-scheduled-message.ts) |
| `search-messages` | Search for messages matching a query | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/search-messages.ts) |
| `lookup-user-by-email` | Look up a user by email address | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/lookup-user-by-email.ts) |
| `get-channel-info` | Retrieve conversation details including topic, purpose, and membership state | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-channel-info.ts) |
| `get-conversation-history` | Fetch paginated message history for a conversation within optional time bounds | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-conversation-history.ts) |
| `get-dnd-info` | Get a user's Do Not Disturb status and next scheduled DND window | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-dnd-info.ts) |
| `get-message-permalink` | Get a permanent URL for a message | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-message-permalink.ts) |
| `get-reactions` | Retrieve all reactions attached to a specific message | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-reactions.ts) |
| `get-team-info` | Retrieve workspace details such as name, domain, and icon | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-team-info.ts) |
| `get-thread-replies` | Fetch paginated thread replies and parent message for a conversation thread | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-thread-replies.ts) |
| `get-upload-url` | Generate an external upload URL and file ID for Slack uploads | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-upload-url.ts) |
| `get-user-info` | Retrieve a user's account details, including profile and avatar fields | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-user-info.ts) |
| `get-user-presence` | Check if a user is online or away | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-user-presence.ts) |
| `get-user-profile` | Retrieve a user's detailed profile, status, and custom fields | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-user-profile.ts) |
| `invite-to-channel` | Invite users to a Slack channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/invite-to-channel.ts) |
| `join-channel` | Join a public or private channel and return its conversation details | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/join-channel.ts) |
| `leave-channel` | Leave a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/leave-channel.ts) |
| `get-channel-members` | List members in a Slack channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/get-channel-members.ts) |
| `list-channels` | List Slack conversations with optional type filters and cursor pagination. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-channels.ts) |
| `list-custom-emoji` | List workspace custom emoji mappings, including alias-based emoji entries | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-custom-emoji.ts) |
| `list-files` | List files shared in the workspace | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-files.ts) |
| `list-pins` | List all items pinned in a specific channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-pins.ts) |
| `list-scheduled-messages` | List pending scheduled messages | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-scheduled-messages.ts) |
| `list-user-group-members` | List member user IDs for a specific Slack user group | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-user-group-members.ts) |
| `list-user-groups` | List workspace user groups with optional disabled and membership counts | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-user-groups.ts) |
| `list-user-reactions` | List items the user reacted to with cursor-based pagination | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-user-reactions.ts) |
| `list-users` | List all users in the workspace | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/list-users.ts) |
| `mark-as-read` | Move a conversation's read cursor to a specific message timestamp | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/mark-as-read.ts) |
| `open-dm` | Open a direct or multi-person DM for specified users | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/open-dm.ts) |
| `pin-message` | Pin a specific message in a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/pin-message.ts) |
| `post-message` | Post a message to a channel, DM, or thread | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/post-message.ts) |
| `remove-reaction` | Remove an emoji reaction from a specific message | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/remove-reaction.ts) |
| `remove-from-channel` | Remove a user from a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/remove-from-channel.ts) |
| `rename-channel` | Rename a Slack channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/rename-channel.ts) |
| `schedule-message` | Schedule a Slack message to a channel or thread, subject to Slack's 120-day scheduling limit. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/schedule-message.ts) |
| `search-files` | Search workspace files with pagination | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/search-files.ts) |
| `send-ephemeral-message` | Send a message visible only to one user in a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/send-ephemeral-message.ts) |
| `send-message` | Send a message to a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/send-message.ts) |
| `set-channel-purpose` | Update a channel's purpose text for a conversation | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/set-channel-purpose.ts) |
| `set-channel-topic` | Set the topic of a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/set-channel-topic.ts) |
| `set-status` | Set a user's status | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/set-status.ts) |
| `set-user-presence` | Set a user's presence to online or away | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/set-user-presence.ts) |
| `start-stream` | Post a new message and open it for incremental streamed updates (e.g. an AI response typed in over time). Confirmed live: only works in DM/IM channels - public and private channels return channel\_type\_not\_supported. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/start-stream.ts) |
| `append-stream` | Append another chunk of content to a message previously opened with start-stream. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/append-stream.ts) |
| `stop-stream` | Finalize a streamed message, optionally attaching closing blocks/metadata and setting its session status. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/stop-stream.ts) |
| `unarchive-channel` | Restore an archived conversation so members can use it again | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/unarchive-channel.ts) |
| `unpin-message` | Remove a pinned message from a channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/unpin-message.ts) |
| `update-message` | Edit an existing message in a Slack channel | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/actions/update-message.ts) |
| `conversations` | Sync Slack conversations including channel members | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/slack/syncs/conversations.ts) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.