Slack Integration: Real-Time Test Updates and Collaboration

These instructions detail how to integrate Ratl with Slack to receive instant notifications for test updates, share test results, and collaborate effectively with your team. Each setup guide provides steps for configuring notifications for load, API, E2E, and accessibility tests, ensuring seamless communication and real-time insights.

Pre-conditions

1. Slack Workspace: Ensure you have access to a Slack workspace.

2. Slack Account: Your account should have permissions to create and manage apps within the workspace.

Step 1: Create a New Slack App

1. Navigate to the Slack API: Go to the Slack API App Management page.

2. Create a New App: Click on "Create New App"

3. Select Manifest Option: Choose "From an app manifest" to define your app's configuration using a manifest file.

Step 2: Select a Workspace

• Choose Workspace: Select the workspace where you want to create and install your app. This is the initial installation point for your app.

Step 3: Define Your App’s Manifest

1. Access Manifest Page: On the Manifest page, you can either create a new manifest or upload an existing one.

2. Use the Following JSON as a Starting Point:

{
  "display_information": {
    "name": "Ratl.ai Bot",
    "description": "A bot to assist with automated tasks and reporting.",
    "background_color": "#EBF6BB"
  },
  "features": {
    "bot_user": {
      "display_name": "Ratl.ai-Bot",
      "always_online": true
    }
  },
  "oauth_config": {
    "scopes": {
      "bot": [
        "commands",
        "chat:write",
        "app_mentions:read",
        "im:history",
        "channels:history",
        "channels:join",
        "channels:manage",
        "channels:read",
        "groups:read",
        "im:read",
        "mpim:read",
        "reactions:write"
      ]
    }
  },
  "settings": {
    "org_deploy_enabled": false,
    "socket_mode_enabled": false,
    "token_rotation_enabled": false
  }
}

• Note: Ensure the JSON is correctly formatted. A missing comma (e.g., after "background_color": "#EBF6BB") can cause errors.

Step 4: Review and Create

1. Review Configuration: Click "Next" to review your app's configuration.

2. Check Permissions and Settings: Ensure all permissions, settings, and features are correctly defined.

3. Create App: Click "Create" if everything is correct.

Step 5: Install the App to Your Workspace

1. Navigate to OAuth & Permissions: After creating the app, go to the "OAuth & Permissions" page.

2. Install App: Click "Install App to Workspace".

3. Review Permissions: Check the requested permissions and click "Allow" to grant them.

Step 6: Add Bot Token

1. Receive Bot Token: After installation, you'll receive a bot token.

2. Integrate with Ratl: Go to the integrations section of Ratl settings.

3. Add Bot Token: Select Slack and input the bot token you received and Click on Submit Token.

4. View Channels: You will see a list of channels where your bot is invited.

• Note: If you don't see any channels. To invite the bot, proceed to the next step.

Step 7: Invite Your App

1. Open Desired Channel: Go to the channel where you want to receive reports.

2. Invite Bot: Type /invite in the channel.

3. Select Bot: In the search window, type "Ratl.ai-Bot" and select it.

4. Configure Channel in Ratl: Return to the integrations section of Ratl settings and select the channel for receiving reports.