Skip to main content

Slack Installation Instructions

Step-by-step setup of the Slack integration in iPaaS.com, including authorizing the connection and configuring the subscription.

This document provides step-by-step instructions for installing and configuring the Slack integration in iPaaS.com. The integration sends alert messages from iPaaS.com to Slack, posting iPaaS.com error-retry alerts to a designated Slack member.

Before You Begin

The Slack integration authenticates to your Slack workspace using a token. You can supply that token in one of two ways:

  • OAuth 2.0 (preferred): No credentials are gathered ahead of time. After you save the subscription, you authorize the iPaaS.com Slack app directly from the subscription page, and an access token is stored for you. This is the simpler method and is recommended for most subscribers.

  • Bot token (alternative): You create your own Slack app from the iPaaS.com manifest, install it to your workspace, and copy its Bot User OAuth Token and Client ID. Complete this before the subscription steps below, because those values go into the API Token and Client ID presets. See Authentication Configuration → Bot token for the full walkthrough.

Subscribers or their MiSP should decide which method to use before starting, because it determines whether the Client ID and API Token presets need real values during setup.

Installation Instructions for Integration Setup

  1. In the Subscriber role, go to Subscriptions Management > Marketplace and click Search Certified Integration Marketplace and Subscribe.

  2. Click the Slack Integration title.

  3. On the Subscription Settings page, click the Subscribe button.

  4. Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.

    • Format: [Product Name] - [Environment/Purpose]

    • Example: Slack - Production

  5. Select Create Default Mappings (recommended). If you do not want to create default mappings and want to create all mappings from scratch yourself, then uncheck this box.

  6. Provide the API URL endpoint for your Slack workspace. NOTE: The Slack API URL is the same for all instances.

    • Environment URLs:

      • Test/Sandbox: https://slack.com/api

      • Production: https://slack.com/api

  7. Enter the Client ID and API Token presets according to the authentication method you chose:

    • OAuth 2.0 (preferred): These presets are not required. Set each to any placeholder value (for example, x). The access token is generated and stored when you authorize the app in the next section.

    • Bot token: Enter your Slack app's Client ID in the Client ID preset and your Slack app's Bot User OAuth Token in the API Token preset. See the Authentication Configuration section for where to find these values.

  8. Enter the API Throttle Limit and related operational settings. See the Operational Configuration section for recommended values.

  9. Click Apply to save the settings.

NOTE: The connection is not validated against Slack when you click Apply. Saving the settings stores them but does not confirm that the supplied credentials are correct. Validation happens when the integration first attempts to send a message.

Authentication Configuration

The Slack integration supports two authentication methods. OAuth 2.0 is preferred because it is simpler and does not require you to manage a token by hand. The bot-token method is available as an alternative.

OAuth 2.0 (preferred)

After saving the subscription, authorize the iPaaS.com Slack app to generate and store an access token. The Client ID and API Token presets are not used in this method and may remain set to a placeholder.

  1. Go to the Slack Subscription you created.

  2. Click the Lock icon to initiate the OAuth 2.0 flow. ​

  3. If you are not already logged into Slack, you will be directed to the login page. After you have logged in, or if you were already logged in, you will be redirected to a page where you need to click the Allow button.

  4. After clicking Allow, the authorization process completes and a confirmation screen appears. Click the Close Page button and refresh the subscription page. The access token is then generated and stored permanently. ​NOTE: Slack's OAuth 2.0 access tokens do not expire and remain valid until the app is deleted.

Bot token (alternative)

Use this method to supply your own Slack app's bot token instead of authorizing the iPaaS.com app through OAuth. You create a Slack app from the iPaaS.com manifest, install it to your workspace, and copy its Bot User OAuth Token and Client ID into the API Token and Client ID presets. Complete these steps before you save the subscription settings above.

1. Create the Slack app from the iPaaS.com manifest.

  1. Go to https://api.slack.com/apps and click Create New App.

  2. Choose From a manifest and select your workspace.

  3. Switch the manifest format to YAML — the editor opens on JSON, and the iPaaS.com manifest is YAML. Paste the manifest below, click Next, then Create.

display_information:
  name: iPaaS.com
  description: Receive notifications from iPaaS.com
  background_color: "#000000"
features:
  bot_user:
    display_name: iPaaS Integration
    always_online: false
oauth_config:
  redirect_urls:
    - https://stagingapi.ipaas.com/HookApi/v2/Authorization/AuthorizationComplete
    - https://api.ipaas.com/HookApi/v2/Authorization/AuthorizationComplete
  scopes:
    bot:
      - channels:join
      - channels:read
      - chat:write
      - chat:write.public
      - groups:write
      - users:read
settings:
  org_deploy_enabled: true
  socket_mode_enabled: false
  token_rotation_enabled: false

2. Install the app and copy the Bot User OAuth Token.

Important: do not use the App-Level Tokens → Generate Token and Scopes option on the Basic Information page. That produces an app-level token that the integration cannot use to post messages — a transfer made with it fails with not_allowed_token_type. Use the bot token from the steps below instead.

  1. In the app's left navigation, under Features, open OAuth & Permissions.

  2. Under OAuth Tokens, click Install to [your workspace].

    OAuth & Permissions — Install to workspace
  3. Review the requested permissions and click Allow.

    Allow the iPaaS.com app to access Slack
  4. After installation, copy the Bot User OAuth Token (it begins with xoxb-) shown under OAuth Tokens, and enter it in the iPaaS.com API Token preset.

    Copy the Bot User OAuth Token

3. Copy the Client ID.

On Basic Information → App Credentials, copy the Client ID and enter it in the iPaaS.com Client ID preset.

Sending to a private channel. A newly installed app is not a member of your private channels, so a send to one fails with channel_not_found until you add the app to that channel. In Slack, right-click the channel and choose View Channel Details, open the Integrations tab, click Add Apps, select the iPaaS.com app, and click Add.

The recipient itself is set by the Channel mapping, not by these presets. To send to a specific channel, set the Channel mapping to return the channel name (for example, return "#chris-private";); to send to an individual member, use await UserIdFromName("username").

NOTE: If both an OAuth access token and a bot token are present, the stored OAuth access token takes precedence. To rely on the bot-token method, make sure no OAuth access token has been generated for the subscription.

Operational Configuration

These settings control how the integration paces its requests to Slack. The recommended values below are starting points; adjust them to suit your message volume.

  • API Throttle Limit

    • Purpose: Limits how many API requests the integration can run at once, protecting system performance and ensuring fair usage.

    • Recommended Values:

      • Initial Setup: 5

      • Ongoing Operations: 500

      • High Volume: 500

Post-Installation Verification

After completing the installation, perform these tests to verify the installation:

Data Sync Test:

  1. Trigger an iPaaS.com error-retry condition, or use Manual Sync, to send a sample alert message from iPaaS.com to Slack.

  2. Confirm the message arrives in Slack, delivered to the designated member resolved from the Channel mapping.

Functionality Test:

  1. Run an end-to-end business process that produces an alert.

  2. Validate key features such as field mappings and message delivery.

  3. Review integration activity under Dashboard → Integration Monitoring → Error Logs to confirm there are no delivery errors.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or to search our documentation. Additional resources include:

Related Documents

Did this answer your question?