Create a webhook Automation to communicate with an external integrated app when a specific event occurs in a ClickUp task.

Take a look at our article Create a Chat webhook Automation to learn about our Chat webhooks

Feature availability and limits vary by plan and user role. Learn more

What are webhooks?

Webhooks are an automated way to send information from ClickUp to your integrations and other systems.

Instead of requesting the information from ClickUp, webhooks send information proactively to keep the data in other systems up-to-date.

The information sent from ClickUp when a webhook is triggered, or called, is known as the payload.

For task webhooks, the payload includes information about the task which triggered the Automation in ClickUp.

You can also set up webhooks using our public API.

Call webhook Actions

From a List, Folder, or Space in ClickUp you can create an Automation triggered by task activity that calls a webhook as an Automation Action.

The following table describes the available Actions:

Each action has a different payload. We recommend using the Call webhook action for any new integrations you're building.

Use URL headers and parameters

Use URL headers and parameters to define details about the webhook, for example:

• The ClickUp location where the webhook is sent from
• The endpoint of the external app
• Or the media type of the request body

URL headers are sensitive. Once they're saved, you can't view the header values to edit them.

Following are the headers we've provided and some guidelines on creating custom headers:

Create a webhook without creating an Automation

To create a webhook before setting up an Automation, from a List, Folder, or Space:

1. Click the Automate button or the lightning bolt icon.
2. Click Manage Automations.
3. Click the Webhooks tab.
4. Click Create webhook.
5. Enter a unique title.
6. Add a description.
7. Enter your webhook URL.
8. Select any dynamic fields to include them in the URL.
9. Add custom headers:
   • By default, webhook headers include Content-type=application/json.
   • Click Add to add more key value pairs.
10. Add optional custom URL Parameters:
    • Enter a key and value to add custom URL parameters.
    • Click Add to add more key value pairs.
11. Click Test webhook to send an example payload.
12. Click Create webhook.

Use an existing webhook in an Automation

To create an Automation using an existing webhook, from a List, Folder, or Space:

1. Click the Automate button or the lightning bolt icon.
2. Click Create Automation.
3. Select the Call webhook Action.
4. Select your webhook from the dropdown menu.
5. Click Create.

Create a webhook using the Call webhook action

To create a webhook while creating an Automation, from a List, Folder, or Space:

1. Click the Automate button or the lightning bolt icon.
2. Click Create Automation.
3. Select the Call webhook Action.
4. Click Create Webhook.
5. Enter a unique title.
6. Add a description.
7. Enter your webhook URL.
8. Select any dynamic fields to include them in the URL.
9. In the Headers section, by default, the content type is set to application/json.
   • To add a custom header, click +Add and enter a key and value.
10. In the Url Parameters section, enter a key and value to add custom parameters.
11. Click Test webhook to send an example payload before enabling your webhook.
12. Click Create webhook.
13. Finish configuring your Automation Trigger, Conditions, and any other Actions.
14. Click Create.

Test your webhook

After creating a webhook, you can test, edit, delete, or deactivate it from the Webhooks tab:

1. Hover over the webhook and click Test.
2. A message displays noting success or failure.

If the test fails

If the test fails, check that the external app is operational. If it's down, we may block the webhook call for security purposes.

If the test is successful

If the test is successful, you can confidently activate the webhook and start using it in Automations!

Failed webhook call

If your webhook is active and a webhook call initially fails, we retry it for 1 hour and 15 minutes. During that time, the call will display in your Automations Activity tab in pending status. 

Deactivate the webhook

After a task webhook is activated, you can make it inactive. 

From the webhooks tab, click the toggle to make an existing webhook inactive.

Any Automations using the webhook will also be made inactive.

Use the Call webhook (Legacy) Action

To use the Call webhook (Legacy) Action, from a List, Folder, or Space:

1. Click the Automate button or the lightning bolt icon.
2. Click Create Automation.
3. Select the Call webhook (Legacy) Action.
4. Enter your webhook URL.
5. Select any dynamic fields to include them in the URL.
6. Click Create.