Overview#
You can integrate ClickUp notifications to automatically create ClickUp tasks for status changes during file transfer tasks.
After completing the integration, a task is automatically created in the designated ClickUp list whenever designated events occur, such as a transfer being Started, Completed, or Failed.
The entire process proceeds in the following order: ① Obtain a Personal API Token → ② Check the target List ID → ③ Configure notifications in the product.
Prerequisites#
Before you begin, check the following.
| Item | Description |
|---|---|
| ClickUp account | A ClickUp account with permission to access and edit the target list is required. The Personal API Token uses the permissions of the account that issued it. |
| Target list | Prepare the ClickUp list where tasks will be created in advance. |
| Network | Outbound HTTPS communication to api.clickup.com (443) must be allowed from the environment where the product is installed. |
Obtain a Personal API Token#
To create tasks in ClickUp, you must obtain a Personal API Token.
Step 1. Open Apps Settings#
Click the profile avatar in the upper-right corner and go to Settings.
Select Apps from the left menu.
Step 2. Create a Personal API Token#
Click Generate under API Token.
If you already have a token, you can select Regenerate to create a new token.
The generated Personal API Token starts with pk_ and does not expire by default.
ℹ️ This token has the same permissions as the account that issued it, so it must be managed like a password and must not be exposed externally. If the token is exposed, you can use Regenerate to invalidate the existing token.
Checklist#
- ✔ A Personal API Token has been created.
- ✔ The token has been copied and stored securely.
Check the Target List ID#
Check the List ID of the target list where tasks will be created.
Step 1. Check the List ID#
Right-click the target list in the sidebar, then select Copy link.
The number after /l/ or /li/ in the copied URL is the List ID.
You can also check the same value in the browser address bar while the target list is open.
Checklist#
- ✔ The List ID of the target list has been confirmed.
ClickUp Notification Settings#
Enter the issued Personal API Token and List ID in the product's notification settings.
When you open the Notifications settings window, the following screen is displayed.
Step 1. Enter the Personal API Token#
Enter the generated token in the Personal API Token field.
Step 2. Enter the List ID#
Enter the confirmed List ID in the List ID field.
Step 3. Select Notification Events#
Select the events for which you want to receive notifications under Events.
You can select multiple events, and ClickUp tasks are created only when the selected events occur.
| Event | When It Occurs |
|---|---|
| Started | When the transfer task starts |
| Completed | When the transfer is completed successfully |
| Paused | When the transfer is temporarily paused |
| Resumed | When a paused transfer starts again |
| Recovered | When the transfer is automatically recovered and resumed after an interruption or error |
| Canceled | When the user cancels the transfer |
| Failed | When the transfer fails |
| Skipped | When a specific file is skipped (Example: an existing file or a file matching a filter condition) |
Step 4. Save the Settings#
After completing the input, click Add to save the integration.
Checklist#
- ✔ The Personal API Token has been entered.
- ✔ The List ID has been entered.
- ✔ The events for which notifications will be received have been selected.
Verify the Integration#
Verify that the settings are working correctly.
Step 1. Trigger a Test Event#
Run an actual transfer task or trigger one of the selected events.
Step 2. Check the ClickUp List#
Check whether a new task has been created in the designated ClickUp list.
Checklist#
- ✔ A task has been created in the ClickUp list.
- ✔ The triggered event was recorded accurately.
Setup Complete#
Once the settings are saved, the integration is applied.
After that, a task is automatically created in the designated ClickUp list whenever the selected events occur.
Troubleshooting#
If tasks are not created, check the following items.
| Issue | What to Check |
|---|---|
| A task is not created | Check whether the Personal API Token and List ID were entered correctly. |
| A 401 authentication error occurs | Check whether the token is valid and has not been invalidated using Regenerate. |
| A 403 permission error occurs | Check whether the account that issued the token has permission to access the target list and create tasks. |
| The list cannot be found | Check whether the List ID is the correct ID of the target list after /l/ or /li/. |
| Integration fails in a closed network | Check whether outbound HTTPS communication to api.clickup.com (443) is allowed by the firewall or proxy. |