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.

Take a look at our article Use Automations Actions to learn about our task webhooks. 

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. Currently, When a message is posted is the only Chat webhook Trigger. 

Actions are the events that the Automation initiates after it is triggered. A Chat webhook Action example is Then call webhook. 

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:

1. Open a Chat Channel.
2. In the upper-right corner, click the lightning bolt icon. 
3. In the Agents modal, select Create.
4. In the Automations modal in the When section, the dropdown is set to Message is posted. More webhook Actions are coming soon!
5. In the Then section, click the first dropdown and select Call webhook.
6. From the Webhook dropdown, select Create webhook.
7. Enter your URL, then select one of the following parameters:
   • Comment ID: Add the individual Chat comment ID to the payload.
   • Channel ID: Add the Chat Channel ID to the payload.
   • To add one or more custom parameters, in the Url Parameters section enter a key and value.
8. In the Headers section, by default the content type is set to JSON.
   • To add a custom header, click +Add and enter a key and value.
9. 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, open any Chat and in the upper-right corner, click the lightning bolt icon. 
   • In the upper-right corner of the Agents modal, click View All, then select 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.
• You can also look at your Automations Activity tab. If the call is pending, we'll keep trying to send the webhook for 24 hours.

If the test is successful

• If the test is successful, make the Chat webhook active. 

Make the Chat webhook active

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.
   • Or, open any Chat and in the upper-right corner, click the lightning bolt icon. 
   • In the upper-right corner of the Agents modal, click View All.
2. In the upper-right corner of the Automations modal click Add Automation.
3. In the Automations modal in the Then section, click the dropdown and select Call webhook.
4. Click the Webhoook dropdown and select the webhook.
5. Click Create.
6. The Manage tab of the Automations modal now displays your new Automation. The Automations have sequentially numbered titles. You may want to enter a description if you haven't already to differentiate your Chat webhooks. 

Turn the Chat webhook off

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

To turn the Chat webhook off:

1. Open the Chat.
2. In the upper-right corner, click the lightning bolt icon. 
3. In the Agents modal, select View all.
4. Ensure that the Active tab is selected. 
5. To the right of the Automation title, click the toggle off. 
6. The Chat webhook is now 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: