Slack Integration Guide

Seamlessly connect Our Platform with your Slack workspace to receive real-time notifications, trigger actions, and streamline your workflows.

Ensure you have your API Key ready. Treat your API Key like a password and do not share it publicly.

Prerequisites

An active Our Platform account.
Administrator privileges in your Slack workspace.
Your Our Platform API Key.

Steps to Integrate

Navigate to your Slack App Directory. You can usually find this by clicking your workspace name in Slack and selecting "Tools & administration" → "Manage apps".

Search for "Our Platform" (or your custom app name if you're building your own integration). If it's not listed, you may need to create a new Slack App first.

Note: For a custom integration, go to api.slack.com/apps and click "Create New App".

Once you've found or created the app, click "Add to Slack" or "Configure" and follow the on-screen instructions.

You will be prompted to authorize the app for your workspace. Grant the necessary permissions.

After authorization, you'll be redirected to the Our Platform integration settings page. Here, you will need to enter your Our Platform API Key.

YOUR_OUR_PLATFORM_API_KEY

You can find your API Key in your Our Platform account settings under "API & Integrations".

Configure the types of notifications you want to receive in Slack. You can typically choose which events trigger messages (e.g., new leads, project updates, system alerts).

Select the Slack channel(s) where you want to receive these notifications. You can specify different channels for different types of events.

Click "Save Integration" or "Connect". You should see a confirmation message, and your Slack integration is now active!

Example Workflow

When a new lead is created in Our Platform, a notification will be sent to the #leads channel in Slack, containing key details about the lead and a link to their profile.


{
  "type": "event",
  "event_type": "new_lead",
  "timestamp": "2023-10-27T10:30:00Z",
  "data": {
    "lead_id": "LD12345",
    "name": "Jane Doe",
    "company": "Acme Corporation",
    "source": "Website",
    "assigned_to": "sales@example.com",
    "url": "https://ourplatform.com/leads/LD12345"
  }
}

Customizing Bot Messages: Our integration supports basic message formatting. For more advanced customization, consider using Slack's Block Kit or explore our advanced API for building custom Slack bots.

Troubleshooting Common Issues

No Notifications Received: Double-check your API Key is correct and that the integration is enabled. Verify that the correct Slack channel is selected and that the bot has permission to post in that channel.
Incorrect Information: Ensure the event triggers and data mapping in Our Platform are configured correctly.
Authorization Errors: Re-authorize the app in Slack if permissions have changed or expired.

If you encounter persistent issues, please refer to our Troubleshooting Guide or contact our support team.