Summary
This integration template for Integrator.io automates the process of notifying a Slack channel when a task in a ClickUp list is marked as complete. Internally, at Nova Module, this flow serves a dual purpose:
- Informs Other Departments: Keeps other departments informed about the completion of features on the roadmap.
- Engineer Recognition: Acknowledges the efforts of the engineers who completed the tasks.
Modify the flow as needed to fit your business needs.
Keep in mind that with ClickUp, while tasks can be part of multiple lists, they have a “primary” list (which is the list the task created in) and will only show up in the response of the Get Task API call if the “primary” list is used in the API call. For example, if task abc is created in list 123 and added to list 987, the Get Task API call will only return task abc when the Get Task API call uses the ID of list 123. Task abc will not be returned when making the Get Task API call with the ID of list 987.
Features
- Integrates ClickUp and Slack
- Monitors for completed tasks within a designated ClickUp List
- Upon task completion, sends a notification to a specific Slack channel
- The notification includes the task title and a customized message. A PreSavePage IO hook was used to create the customized message text according to Slack’s reference article found here
Flows
- Closed Roadmap Tasks' notifications: Exports closed tasks from ClickUp to a Slack channel
Prerequisites
- ClickUp Account: A ClickUp account with API access enabled.
- Slack Account: A Slack account with permissions to create an app. The Slack App’s token will be used to create the Slack connection on integrator.io
- Slack channel: A Slack channel to receive the notifications
Setting Up the Integration
- Download the Integration Template: In integrator.io, navigate to the Marketplace, find the “ClickUp - Snowflake” template and click “Install”
-
Configure Connections by following the installation steps:
- ClickUp: Provide your ClickUp API key and access token. Refer to ClickUp's documentation for API access instructions: https://clickup.com/api/
- Slack: Use Celigo’s help article to create the Slack Token connection.
-
Update Settings: Navigate to the settings of the “ClickUp - Slack” integration tile and update the following
- roadMapList: Provide the unique identifier (ID) for the ClickUp list containing the tasks that should be exported
- checkboxFieldID: At Nova Module, we use a checkbox in ClickUp to mark tasks that should appear on our Product Roadmap. If you use a checkbox for additional filtering, please include its ClickUp ID here.
- Export Filtering: Below is the filtering used in the Relative URI. Please update the filters based on your business requirements. The ClickUp List ID will be taken from the settings. If you do not use a checkbox, please be sure to remove the section in bold below. Kindly note that the status is a custom status so be sure to update it to the status you use in your configuration.
list/{{settings.flowGrouping.roadmapList}}/task?archived=false&order_by=id&reverse=true&subtasks=false&statuses[]=released%20%2F%20complete&include_closed=true&date_closed_gt={{lastExportDateTime}}&custom_fields=[{"field_id":"{{settings.flowGrouping.checkboxFieldID}}","operator":"=","value":"true"}]&date_done_gt={{lastExportDateTime}}
- PreSavePage IO hook: This hook was used to format the Slack message. You will need to update this hook to format the message per your requirements.
- Data Mapping: You should only need to update the Slack Channel ID. If you change the JSON property for the message text, please update the mapping as well.
- Test: After configuration, test the data flow to ensure data is sent to Slack. You can either use the lastExportDateTime and select a time when integrator.io shows a popup or hardcode the date_closed_gt & date_done_gt
- Run: Once you are satisfied with the results of the test runs, set the flow to run on a delta and configure the schedule.
Reminders
- This template provides a basic flow for exporting ClickUp data to Slack. You can modify the flow and the related IO hook to suit your specific needs.
- Ensure you have the necessary permissions within ClickUp and Slack to access and modify data.
- If you need further assistance, please contact support@novamodule.com