Channels

Messages

Users

Slack

Get analytics data file

Approve an app install request

List approved apps

Clears an app resolution set for an app on a specific workspace or enterprise

Get app config information

Set app config

This App Management API method cancels an app install request that was created within a workspace or Enterprise Grid.

Cancel an app install request

List pending app install requests

Restrict an app

List restricted apps

This endpoint will uninstall an app from one or many workspaces, or an entire enterprise.

Uninstall an app

API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration

API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.

NOTE: Writing to this endpoint will overwrite previously added IP ranges and ASNs. If customers are adding new IP ranges and ASNs they must include all of the previously added IP ranges and ASNs in your new API call or they will be overwritten.

The token argument is required and is a session token (xoxc- or xoxp-).

Please note that the xoxp- token must be:

* created by an org admin
* have a user token scope of admin

Additionally, the app using the token must be installed at the org level.

The trusted_asns argument is optional and is an allow list of asns as integers.

The trusted_cidrs argument is optional and is an allow list of IPs using CIDR notation as strings.

The response is a JSON string containing the field ok. Successful writes have a true status while unsuccessful writes that are not errors will return false.

Update the allow list of IP blocks and ASNs from the enterprise configuration

Assign entities to an authentication policy

Get entities assigned to a particular authentication policy

Remove entities from an authentication policy

Create a new information barrier

Delete an existing information barrier

List all existing information barriers

Update an existing information barrier

Archive a channel

Bulk archive channels

Delete channels in bulk

Move channels in bulk

Convert a public channel to a private channel

Convert a private channel to a public channel

Create a public or private channel

Delete a channel

Disconnect one or more workspaces from a connected channel

List original connected channel info

Get conversation preferences

Get the retention policy for a conversation

Get the workspaces connected to a given channel within the organization

This Admin API method invites a user to a channel.

Invite a user to a channel

Lookup admin conversations

Remove the retention policy for a conversation

Rename a public or private channel

Add IDP group to private channel's allowlist

List IDP groups allowed access to a private channel

Remove IDP group from a private channel's allowlist

Search for channels across an organization

Set the posting permissions for a channel

Set the retention policy for a conversation

Set the workspaces connected to a channel

Unarchive an archived channel

Add a custom emoji

Add an alias for an emoji

List emoji across an Enterprise Grid organization

Remove a custom emoji

Rename a custom emoji

List all functions installed by a set of app IDs

Look up permissions for a set of functions

Set permissions for a function

Approve invite request

List approved invite requests

List denied workspace invite requests

Deny invite request

List pending invite requests

Add assignments to admin roles

List role assignments

Revoke role assignments for specific users and entities

Get a list of admins for a given workspace

Create a workspace for an enterprise organization

This Admin API lists workspaces in an enterprise organization.

List workspaces in an enterprise organization

Get a list of owners for a given workspace

Fetch information about settings in a workspace

Set the default channels of a workspace

Set the description for a workspace

Set the discoverability of a workspace

Get team settings icon

Set the name of the workspace

Add default channels to an IDP group

Use this method to add workspaces to an organization-wide IDP Group. When you link workspaces to an IDP group, you automatically add members of the IDP group to those workspaces.

Add workspaces to an organization-wide IDP Group

List default channels for an IDP group

Remove channels from an IDP group

This Admin API assigns a user to a workspace. If the user has never been a member of the workspace, they will be added. If they've previously been removed or left the workspace, the user will be reinstated as a member.

Assign a user to a workspace

Invite a user to a workspace

List users in a workspace

Remove a user from a workspace

Clear session settings for users

This API method can only be used on Enterprise Grid workspaces.

Get session settings for users

This Admin API invalidates a single session for a user on a workspace. The user will be logged out and forced to login again. If the user has multiple sessions with multiple devices, the other sessions will be unaffected. If you'd like to reset all sessions for a given user, use the admin.users.session.reset method instead.

Invalidate a session for a user on a workspace

List active login sessions

This method wipes a user session, leaving the user unauthenticated. The user’s Slack client will reset its local cache.

By default, this method resets all sessions for a given user. Use the web_only and mobile_only parameters to wipe only web or only mobile sessions.

Reset a user session

This method enqueues a job that wipes sessions for a list of users, leaving them unauthenticated. The users' Slack clients will reset their local cache.

Reset sessions for multiple users

Set session settings for users

Converts a user to an admin user

This Admin API method sets the expiration of a single-channel or multi-channel guest, processed on an hourly schedule. For instance, if a guest is set to expire at 11:10 am PDT, they will expire at 12:00 pm PDT.

Set the expiration of a single-channel or multi-channel guest

Converts a user to a workspace owner

Converts a user to a full user

Export unsupported software users

Add collaborators to workflows

Remove collaborators from workflows

Lookup permissions for workflows

Search workflows

Unpublish a set of workflows built in Workflow Builder

This method helps you test your calling code.

You can also use this method as a very basic way to test whether Slack's Web API is functioning. Learn more.

You can't use this method with a Sign in with Slack token.

Test API

List activities for an app

Delete external app tokens

Get external token

Microsoft Sharepoint

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Monday

Freshsales

Keap

Jira

SugarCRM

Asana

Outreach

Xero

ActiveCampaign

Capsule CRM

Github

Notion

Salesloft

Clickup

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Zendesk

Attio

Copper

Microsoft Teams

Greenhouse Harvest

Zoho Books

Front

Calendly

Close

Freshdesk

BambooHR

Breezy HR

Basecamp

Okta

Deel

Lever

Google Workspace

Microsoft Entra ID

# Continuous Import of Users to Your App

This scenario enables your application to continuously sync Users from any external application to your app's API. It handles the initial import of Users and keeps them synchronized when a User is created, updated, or deleted in the external application.

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Users to my App

Import Users and receive created/updated or deleted events

# Delete Message

This scenario allows your application to delete a Message from any external application. 
You will pass ID of the Message you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Message API call**:
   - Call Integration.app REST API or SDK with ID of the Message you want to delete and Integration.app will send the correct request to the external app.


Delete Message

Deletes Message in any external application

# Continuous Import of Messages to Your App

This scenario enables your application to continuously sync Messages from any external application to your app's API. It handles the initial import of Messages and keeps them synchronized when a Message is created, updated, or deleted in the external application.

When receiving Messages data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Messages to my App

Import Messages and receive created/updated or deleted events

# Realtime Full two-way Sync of Messages

This scenario enables your application to fully sync Messages between your app and any external application in both directions. It handles the initial import/export of Messages and then sends events when a Message is created, updated, or deleted on any side, as close to real-time as possible.

Message fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Messages in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Messages to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Messages

Bi-directional realtime sync of Messages with records deduplication

# Create Message

This scenario allows your application to create a Message in any external application in the same way. 
You will pass Message fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Message with and configure mapping to our default model

2. **Create Message API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Message data into a format compatible with the selected external application.
   - It then makes an API call to create the Message in that specific application.


Create Message

Creates Message in any external application

# Update Message

This scenario allows your application to update a Message in any external application in the same way. 
You will pass  ID of the Message you want to update and Message fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Message with and configure mapping to our default model

2. **Create Message API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Message data into a format compatible with the selected external application.
   - It then makes an API call to update the Message in that specific application.


Update Message

Updates Message in any external application

# Get all Messages

This scenario enables your application to get a complete list of Messages from any external application to your app's API in the same way. 

When receiving Messages data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Messages along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Messages page by page.


Get all Messages

Imports all Messages from any external application to your App.

# Get all Users

This scenario enables your application to get a complete list of Users from any external application to your app's API in the same way. 

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Users along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Users page by page.


Get all Users

Imports all Users from any external application to your App.

# Realtime Full two-way Sync of Users

This scenario enables your application to fully sync Users between your app and any external application in both directions. It handles the initial import/export of Users and then sends events when a User is created, updated, or deleted on any side, as close to real-time as possible.

User fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Users in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Users to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Users

Bi-directional realtime sync of Users with records deduplication

# User Unified API

This scenario contains the complete Users Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Users while also receiving notifications on creation, updates, and deletions of Users in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Users Unified API

Slack API Integration Profile