Ctrlk
Book a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Slack

Integrate Slack with OX to receive real-time security alerts, incident updates, and workflow notifications directly within your Slack channels or private messages.

The OX Slack integration is subject to the OX Terms of Service: https://www.ox.security/terms-of-service/

This integration streamlines incident management, reduces response time, enhances team collaboration, and enables you to:

  • Send information about an individual issue to Slack

  • Add OX-Slack related tasks as part of OX workflows

Connection methods

You can connect OX to Slack in one of two ways:

  • OX Slack App: Use the published OX Security Alerts Slack app. It will be added to your Slack workspace during authorization.

  • Token: Use your own Slack app by providing its Bot User OAuth Token. For this method, add the permission scopes described in the section Permission scopes.

Prerequisites

Connection
OX
Slack

OX Slack App

Permission to configure connectors

Workspace with installation permissions

Slack Token

Permission to configure connectors

Workspace with installation permissions A Slack app with permissions listed in the section Permission scopes.

Permission scopes

Both connection methods use the OAuth scopes listed in the table.

  • The Slack integration requests OAuth scopes to enable OX to display the list of channels (public and private) and people in your workspace. This allows you to choose where to send an issue.

  • Once you've made your selection, OX needs permission to send the message to that channel or person.

  • If you use the OX Slack app method, the scopes are automatically configured when you authorize the OX Security Alerts app. If you connect with a token, you add the scopes yourself.

Scope
Required / Optional
Description

chat:write

Required

Send messages as the app (alerts and issue notifications).

channels:read

Required

View basic information about public channels so you can select where to publish an issue.

groups:read

Required

View basic information about private channels so you can select where to publish an issue.

users:read

Required

View people in the workspace (for the channel/user picker).

users:read.email

Required

View email addresses of people in the workspace (to resolve users by email when needed).

chat:write.public

Optional

Send messages to public channels the app is not a member of. Only required when posting to a channel the app has not been added to.

For full scope descriptions, see Slack's OAuth scopes documentation.

Connect with the OX Slack App

Use the published OX Security Alerts Slack app. The connection process adds the app to your Slack workspace during authorization. The OX Security Alerts app includes the required OAuth scopes.

  1. Verify that the prerequisites are in place.

  2. In the OX app, go to Connectors > Dev Alerts and select Slack.

  3. In Configure your Slack credentials, select IDENTITY PROVIDER.

  4. Select VERIFY CONNECTIVITY. A green success message at the bottom of the screen indicates a successful connection. If verification fails, check your credentials and permissions.

  5. Select CONNECT.

  6. You are redirected to Slack to authorize OX Security Alerts.

  7. In Slack, review the requested permissions and select Allow.

  8. After authorization, you are returned to OX.

The Slack connector is configured and ready to use.

Connect with a Token

Step 1: Create a Slack app [Slack]

  1. Verify that the prerequisites are in place.

  2. Create a Slack app in the Slack API (or use an existing one).

  3. In your app's OAuth & Permissions, scroll down to Bot Token Scopes.

  4. Add the required scopes listed in the permissions scopes table. As a minimum, add:

    • chat:write

    • channels:read

    • groups:read

    • users:read

    • users:read.email

    • Add chat:write.public if you need to post to public channels the app is not in.

  5. Install or reinstall the app to your workspace.

  6. Copy the Bot User OAuth token (starts with xoxb-). Best practice: Store the Bot User OAuth token securely. OX uses it to call the Slack API on your behalf within the scopes you granted.

Step 2: Connect to OX [OX]

  1. In the OX app, go to Connectors > Dev Alerts and select Slack.

  2. In Configure your Slack credentials, select TOKEN.

  3. Enter the following parameters.

Parameter
Description

Slack Host URL

The Slack URL for your account

Token

The Slack token

  1. Select VERIFY CONNECTIVITY. A green success message at the bottom of the screen indicates a successful connection. If verification fails, check your credentials and permissions.

  2. Select CONNECT.

Send a message to a Slack channel

You can send issue notifications to Slack channels directly from the Active Issues page.

  1. In Active Issues, locate the issue.

  2. You can send the message to Slack from the bottom of an issue (left) or from the 3-dots menu (right).

  3. Select Send to Slack.

  4. The Send to Slack dialog opens.

    • Channel/User: Choose the Slack channel where you want to send the notification.

    • Add your own comment (optional): Add a comment to provide additional context.

  5. Select SEND.

Add Slack messages to workflows

  1. In OX, go to Workflows.

  2. Select the relevant workflow.

  3. Find the workflow step where you want to add the Slack action and select +.

  4. Select Action > Slack.

  5. Configure the following settings.

Setting
Description

Select channel

Choose the Slack channel where notifications should be sent

(Optional) Add your own comment

Add a custom message to provide additional context. It's good practice to explain the reason for the notification.

Execute on

Select the condition that triggers this action:

• New, Updated or Existing Issues • Periodic

  1. Select ADD.

The new Slack action appears in the workflow. When the workflow runs and the specified condition is met, OX sends a notification to the configured Slack channel.

Last updated