Elastic Slack connector reference

Elastic Slack connector referenceedit

The Slack connector is written in Python using the Elastic connector framework.

View the source code for this connector (branch 8.14, compatible with Elastic 8.14).

Native connector reference (managed service)edit

View reference for the native connector reference (managed service).

Availability and prerequisitesedit

This native connector was introduced in Elastic 8.14.0 as a managed service on Elastic Cloud.

To use this connector natively in Elastic Cloud, satisfy all native connector requirements.

This connector is in technical preview and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Technical preview features are not subject to the support SLA of official GA features.

Create a Slack connectoredit

Use the UIedit

To create a new Slack connector:

  1. Navigate to the Search → Connectors page in the Kibana UI.
  2. Follow the instructions to create a new native Slack connector.

For additional operations, see Using connectors.

Use the APIedit

You can use the Elasticsearch Create connector API to create a new native Slack connector.

For example:

PUT _connector/<my-slack-connector>
{
  "index_name": "<my-elasticsearch-index>",
  "name": "Content synced from Slack",
  "service_type": "slack",
  "is_native": "true"
}
You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

  1. Run the following command, replacing values where indicated. Note the id and encoded return values from the response:

    POST /_security/api_key
    {
      "name": "<connector_name>-connector-api-key",
      "role_descriptors": {
        "<connector_name>-connector-role": {
          "cluster": [
            "monitor"
          ],
          "indices": [
            {
              "names": [
                "<index_name>",
                ".search-acl-filter-<index_name>",
                ".elastic-connectors*"
              ],
              "privileges": [
                "all"
              ],
              "allow_restricted_indices": false
            }
          ]
        }
      }
    }
  2. Use the encoded value to store a connector secret, and note the id return value from this response:

    POST _connector/_secret
    {
      "value": <encoded_api_key>
    }
  3. Use the API key id and the connector secret id to update the connector:

    PUT /_connector/<connector_id>/_api_key_id
    {
      "api_key_id": "<API key id>",
      "api_key_secret_id": "<secret id>"
    }

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usageedit

To use this connector in the UI, select the Notion tile when creating a new connector under Search → Connectors.

If you’re already familiar with how connectors work, you can also use the Connector APIs.

For additional operations, see Using connectors.

You need to create a Slack application to authenticate with Slack.

Create a Slack applicationedit

When created you’ll receive a credential that the connector uses for authentication. A new Bot user will also be created.

The connector will only sync messages from the channels of which the Bot user is a member.

To create the app, follow these steps:

  1. Go to https://api.slack.com/apps and click "Create New App".
  2. Choose "From Scratch".
  3. Name the app, and select the workspace you want to sync from. Depending on the workspace’s settings, you may get a warning about requiring admin approval. That will be handled later.
  4. Navigate to "OAuth & Permissions" in the sidebar.
  5. Scroll down to the "Scopes" section and add these scopes:

    • channels:history
    • channels:read
    • users:read.

      Optionally, you can also add channels:join if you want the App Bot to automatically be able to add itself to public channels.

  6. Scroll up to "OAuth Tokens for Your Workspace" and install the application. Your workspace may require you to get administrator approval. If so, request approval now and return to the next step once it has been approved.
  7. Copy and save the new "Bot User OAuth Token". This credential will be used when configuring the connector.

Configurationedit

The following settings are required to set up this connector:

token(required)
The Bot User OAuth Token generated by creating and installing your Slack App.
fetch_last_n_days(required)
The number of days of history to fetch from Slack. This must be a positive number to fetch a subset of data, going back that many days. If set to 0, it will fetch all data since the beginning of the workspace. The default is 180 days.
auto_join_channels(required)
Whether or not the connector should have the App’s Bot User automatically invite itself into all public channels. The connector will only sync messages from the channels of which the Bot user is a member. By default, the bot will not invite itself to any channels, and must be manually invited to each channel that you wish to sync. If this setting is enabled, your App must have the channels.join scope.
sync_users(required)
Whether or not the connector should index a document for each Slack user. By default, the connector will create documents only for Channels and Messages. However, regardless of the value of this setting, the Slack App does need the users.read scope and will make requests to enumerate all of the workspace’s users. This allows the messages to be enriched with human-readable usernames, and not rely on unreadable User UIDs. Therefore, disabling this setting does not result in a speed improvement, but merely results in less overall storage in Elasticsearch.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not available for this connector in the present version.

For more information read Types of sync rule.

Content Extractionedit

This connector does not currently support processing Slack attachments or other binary files.

Documents and syncsedit

The connector syncs the following objects and entities:

  • Channels
  • Messages
  • Users (configurable)
  • Only public channels and messages from public channels are synced.
  • No permissions are synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Known issuesedit

There are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

Connector client reference (self-managed)edit

View reference for the connector client reference (self-managed).

Availability and prerequisitesedit

This connector is available as a self-managed connector client from the Elastic connector framework.

This connector client is compatible with Elastic versions 8.10.0+.

To use this connector, satisfy all connector client requirements.

This connector is in technical preview and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Technical preview features are not subject to the support SLA of official GA features.

Create a Slack connectoredit

Use the UIedit

To create a new Slack connector:

  1. Navigate to the Search → Connectors page in the Kibana UI.
  2. Follow the instructions to create a new Slack connector client.

For additional operations, see Using connectors.

Use the APIedit

You can use the Elasticsearch Create connector API to create a new self-managed Slack connector client.

For example:

PUT _connector/my-slack-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Slack",
  "service_type": "slack"
}
You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

  1. Run the following command, replacing values where indicated. Note the encoded return values from the response:

    POST /_security/api_key
    {
      "name": "<connector_name>-connector-api-key",
      "role_descriptors": {
        "<connector_name>-connector-role": {
          "cluster": [
            "monitor"
          ],
          "indices": [
            {
              "names": [
                "<index_name>",
                ".search-acl-filter-<index_name>",
                ".elastic-connectors*"
              ],
              "privileges": [
                "all"
              ],
              "allow_restricted_indices": false
            }
          ]
        }
      }
    }
  2. Update your config.yml file with the API key encoded value.

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usageedit

To use this connector as a connector client, use the Connector workflow in the Kibana UI.

For additional operations, see Using connectors.

You need to create a Slack application to authenticate with Slack.

Create a Slack applicationedit

When created you’ll receive a credential that the connector uses for authentication. A new Bot user will also be created.

The connector will only sync messages from the channels of which the Bot user is a member.

To create the app, follow these steps:

  1. Go to https://api.slack.com/apps and click "Create New App".
  2. Choose "From Scratch".
  3. Name the app, and select the workspace you want to sync from. Depending on the workspace’s settings, you may get a warning about requiring admin approval. That will be handled later.
  4. Navigate to "OAuth & Permissions" in the sidebar.
  5. Scroll down to the "Scopes" section and add these scopes:

    • channels:history
    • channels:read
    • users:read.

      Optionally, you can also add channels:join if you want the App Bot to automatically be able to add itself to public channels.

  6. Scroll up to "OAuth Tokens for Your Workspace" and install the application. Your workspace may require you to get administrator approval. If so, request approval now and return to the next step once it has been approved.
  7. Copy and save the new "Bot User OAuth Token". This credential will be used when configuring the connector.

Deploy with Dockeredit

You can deploy the Slack connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.api_key
  • connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: slack
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.14.1.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this README in the elastic/connectors repo for more information.

Configurationedit

The following settings are required to set up this connector:

token(required)
The Bot User OAuth Token generated by creating and installing your Slack App.
fetch_last_n_days(required)
The number of days of history to fetch from Slack. This must be a positive number to fetch a subset of data, going back that many days. If set to 0, it will fetch all data since the beginning of the workspace. The default is 180 days.
auto_join_channels(required)
Whether or not the connector should have the App’s Bot User automatically invite itself into all public channels. The connector will only sync messages from the channels of which the Bot user is a member. By default, the bot will not invite itself to any channels, and must be manually invited to each channel that you wish to sync. If this setting is enabled, your App must have the channels.join scope.
sync_users(required)
Whether or not the connector should index a document for each Slack user. By default, the connector will create documents only for Channels and Messages. However, regardless of the value of this setting, the Slack App does need the users.read scope and will make requests to enumerate all of the workspace’s users. This allows the messages to be enriched with human-readable usernames, and not rely on unreadable User UIDs. Therefore, disabling this setting does not result in a speed improvement, but merely results in less overall storage in Elasticsearch.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not available for this connector in the present version.

For more information read Types of sync rule.

Content Extractionedit

This connector does not currently support processing Slack attachments or other binary files.

Documents and syncsedit

The connector syncs the following objects and entities:

  • Channels
  • Messages
  • Users (configurably)
  • Only public channels and messages from public channels are synced.
  • No permissions are synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Connector client operationsedit

End-to-end testingedit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the GitHub connector, run the following command:

$ make ftest NAME=slack

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=slack DATA_SIZE=small

Known issuesedit

There are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.