Slack Channel Integration Recipes

Create a Slack Channel for new GUIDEcx Projects and forward Notes and Updates to it.

Stacey Hatch avatar
Written by Stacey Hatch
Updated over a week ago

Overview

This integration between GUIDEcx and Slack creates a dedicated Slack Channel for new GUIDEcx projects and forwards Project and Task Notes, Project Status Updates, and Task Completion Updates to the channel.

When a new project is created in GUIDEcx the integration creates a dedicated Slack channel for the project and optionally (yes by default) invites the project manager and any team members assigned tasks at the template level to the Slack channel.

When a user adds a project note containing the phrase "#Slack" (case insensitive) to a project, the integration forwards the note to the dedicated Slack Channel. When a Project or Task note includes a user nickname using the format #Slack:Nickname (configured in the Slack Channel ID's Lookup Table), the note is also forwarded to the user as a direct message in Slack.

Additionally, When a project's status changes, a slack message is sent to the projects dedicated Slack channel.

Finally, you can specify Tasks that you want to be notified in Slack when completed. When those tasks are completed in a project, an alert is forwarded to the the dedicated slack channel.


Understanding the GUIDEcx/Slack Integration

The GUIDEcx/Slack Channel Integration consists of 5 recipes.

The Create Slack Channel for New GUIDEcx Project recipe creates the slack channel when a new project is created in GUIDEcx and adds the Slack Channel ID as a hidden property on the Project in GUIDEcx. It then optionally invites the Project Manager and any team members assigned tasks at the template level to the channel.

The Forward GUIDEcx Project Notes to Slack recipe will forward Project Notes that contain #Slack (case-insensitive) to the Slack channel specified in the Slack Channel ID Project Property. Additionally it will forward the project notes as a direct message to a user in Slack if their nickname is included in the note using the #Slack:Nickname format.

The Forward GUIDEcx Task Notes to Slack recipe will forward Task Notes as a direct message to a user in Slack if their nickname is included in the note using the #Slack:Nickname format.

The Send Slack Message When GUIDEcx Project Status Changes recipe will forward Project Status Change updates to the Slack channel specified in the Slack Channel ID Project Property.

The Send Slack Message When Specific GUIDEcx Tasks Marked Done recipe will send a Slack message to the Slack channel specified in the Slack Channel ID Project Property, when tasks specified in the Trigger are marked as "Done" in GUIDEcx.

In addition to the recipes, this integration uses a Lookup Table with 4 Columns.

  1. User or Group Name

  2. User or Group Email

  3. User or Group Nickname

  4. User or Group Slack Channel ID

When the trigger phrase is added in a note, this integration looks up the Nickname in the User or Group Nickname column. It then utilizes the Slack user ID found in the corresponding User or Group Slack Channel ID column to send the message. The User or Group Email column is used by other Slack Integration Recipes to forward task assignments in GUIDEcx and the User or Group Name column is only for human reference to aid in identifying columns.

Warning: For these recipes to work properly, the nickname in the User or Group Nickname column needs to be lowercase.


Setting Up the Slack Integration

Follow these steps to set up the Slack integration in Recipe Builder:

  1. Create a user in Slack to act as the GUIDEcx Integration Bot.

    1. Follow the steps outlined in Slack's Documentation to add a user. You can use a dedicated email address or your regular email address with a +alias added. For example if you already have a user with the email hayley@bivouacorp.com you can use hayley+integrationbot@bivouacorp.com for the new user. Slack will treat this as a unique email address, but all emails will go to the same inbox.

    2. Download the GUIDEcx Integration Bot avatar image from here.

    3. Sign in to Slack as GUIDEcx Integration bot and follow the steps outlined in Slack's Documentation to Edit the profile.

      1. Set the Display Name to "GUIDEcx Integration Bot"

      2. Upload the avatar image.

  2. Create a Lookup Table

    1. Title the Lookup Table Slack Channel IDs.

    2. Import the following .csv file to create the column headers: Slack Channel IDs Schema.csv

    3. Add rows to the lookup table for each user you wish to assign tasks to via Slack and any potential GUIDEcx project manager.
      Refer to Slack's Documentation to learn how to retrieve a user ID for the User or Group Slack Channel ID column.

  3. Install the Recipes.
    In the recipes tab, search for the following recipes by name and hit enter to return the search results by recipe instead of application.

    1. Sign in to slack using the credentials for the "GUIDEcx Integration Bot" user created in Step 2.

  4. Set up the Recipes.
    Refer to the individual articles for instructions on how to set up the recipes:


FAQs

Does this integration forward responses from Slack to GUIDEcx?

No. Out of the Box, this integration only forwards messages from GUIDEcx to Slack.


Did this answer your question?