Create a Chat webhook Automation to communicate with an external integrated app when a specific event occurs in ClickUp. For example, when a Chat message is posted in a particular Channel, it also automatically posts to Zapier or Make.

You can also use webhooks with task Automations.

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

Use Automation Triggers, Actions, URL headers, and parameters

Triggers are events that start an Automation. 

Message is posted is the only Chat webhook Trigger. 

Actions are the events that the Automation initiates after it is triggered. To call a webhook, use the Call webhook Action.

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.

Create a Chat webhook Automation

To create a Chat webhook Automation, from a channel:

1. In the upper-right corner, click the Automate button or the lightning bolt icon.
2. Click Create Automation.
3. Configure your Trigger, Conditions, and Actions:
   1. Select the Call webhook Action.
   2. Select an existing webhook or Create webhook:
      1. Give your webhook a name and optional description.
      2. Enter your webhook URL.
      3. Select the following dynamic fields to include them in the URL.
         • Comment ID: Add the individual Chat comment ID.
         • Channel ID: Add the Chat Channel ID.
      4. Add optional custom headers:
         • Click Add, then enter a key and value.
           • By default, webhook headers include Content-type=application/json.
      5. Add optional custom URL Parameters:
         • Enter a key and value to add custom URL parameters.
         • Click Add to add more key value pairs.
4. Click Create webhook.

Test a Chat webhook Automation

After creating the webhook, you can test it from ClickUp. 

To test a Chat webhook Automation:

1. Directly after you create the webhook, in the upper-left corner of the Automation modal, click the caret.
   Or, from a channel:
   1. Click the Automate button or the lightning bolt icon.
   2. Select Manage Chat Automations.
   3. Click the Webhooks tab.
2. Hover over the webhook and click Test.
   • A message displays noting success or failure. 

If the test fails

You can check to see if 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 make the Chat webhook active in an Automation.

Create a chat Automation with an existing webhook

After testing the Chat webhook, you'll make it active in your Workspace. 

To activate the Chat webhook:

1. Directly after you test the webhook, in the Automations modal select the Manage tab.
2. Click Add Automation.
3. Configure your Trigger, Conditions, and Actions:
   1. Select the Call webhook Action.
   2. Select your webhook.
4. Click Create.

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. 

Turn the Chat webhook off

After the Chat webhook is activated, you can make it inactive. 

To turn the Chat webhook off, from a channel:

1. Click the Automate button or the lightning bolt icon.
2. Select Manage Chat Automations.
3. Click the Webhooks tab.
4. To the right of your webhook, click the toggle to deactivate it.
5. Review the warning that Automations using the webhook will also be deactivated.
6. Click Disable.
7. The Chat webhook is now displayed in the Inactive tab.

To turn the Chat webhook back on, open the Inactive tab and click the toggle on.

Header keys and values

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