Skip to main content

Slack Destination

slack_api.png

Slack

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Slack location.

Create a Slack Destination​

  1. Click the + icon on the Nexset that will be sent to the Slack destination, and select the Send to Destination option from the menu.

  2. Select the Slack connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Slack organization, and click Next; or, create a new Slack credential for use in this flow.

  3. In Nexla, Slack destinations can be created using pre-built endpoint templates, which expedite destination setup for common Slack endpoints. Each template is designed specifically for the corresponding Slack endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Slack destinations can also be configured manually, allowing you to send data to Slack endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Slack endpoints. Each template is designed specifically for the corresponding Slack endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Send Message

    This endpoint sends messages to Slack channels or direct messages. Use this template when you need to automatically send notifications, alerts, or data updates to Slack channels based on data from your Nexla flows.

    • Enter the Channel ID in the Channel ID field. This is the unique identifier for the Slack channel where you want to send messages. You can find this ID by using the "List Channels" source endpoint or in your Slack workspace.
    • The endpoint will automatically send message data from your Nexset to the specified Slack channel.
    • Each record in your Nexset will be processed as a separate message, allowing you to send multiple messages or notifications at once.

    Channel IDs are unique identifiers that can be obtained from your Slack workspace or by using Slack's API to list channels. Ensure you have the correct Channel ID before configuring this endpoint. For complete information about message sending, see the Slack API Documentation.

    Upload File

    This endpoint uploads files to Slack channels or direct messages. Use this template when you need to automatically share files, reports, or documents to Slack channels based on data from your Nexla flows.

    • Enter the Channel ID in the Channel ID field. This is the unique identifier for the Slack channel where you want to upload files. You can find this ID by using the "List Channels" source endpoint or in your Slack workspace.
    • The endpoint will automatically upload file data from your Nexset to the specified Slack channel.
    • Each record in your Nexset will be processed as a separate file upload, allowing you to share multiple files or documents at once.

    Channel IDs are unique identifiers that can be obtained from your Slack workspace or by using Slack's API to list channels. Ensure you have the correct Channel ID before configuring this endpoint. For complete information about file uploads, see the Slack API Documentation.

Configure Manually​

Slack destinations can be manually configured to send data to any valid Slack API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Slack API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Slack API from the Method pulldown menu. The most common methods for Slack destinations are:

    • POST: For creating new resources (most common for Slack destinations)
    • PUT: For updating existing resources
    • PATCH: For partial updates to existing resources
    • DELETE: For removing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Slack API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

Slack APIs typically expect JSON format for most operations. Choose JSON unless you have specific requirements for other formats like form data for file uploads.

API Endpoint URL​

  1. Enter the URL of the Slack API endpoint to which you want to send the Nexset data in the URL field. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Request Headers​

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

  • If any record attributes in the Nexset should be omitted when sending data to this Slack destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Record batching is particularly useful for Slack destinations when you need to process large numbers of messages or notifications efficiently. Batching can help reduce API calls and improve performance.

Response Webhook​

Nexla can automatically send the response received from the Slack API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Response webhooks are particularly useful for Slack destinations to track message delivery status, file upload confirmations, and any error responses from the Slack API.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Slack API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Slack API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Slack API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Slack endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Slack endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.