---
title: "addWebhook"
canonical: "https://support.appfire.com/space/JCLI/70789680/addWebhook"
format: markdown
---
> Macro (aura-html)

See also: [Actions](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70787366)

> Macro (details)
> 
> | **Description** | Add a user defined webhook. By default, the webhook will be enabled. Use '--options disable' to disable the webhook. By default, the webhook will send a payload body as part of the post to the url depending on the type of event. Use '--options excludeBody' to prevent the sending of the payload body. In this case, the only information available to the receiving service will be the query parameters on the url. |
> | --- | --- |
> | **Required Parameters** | [name](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784183), [url](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784481) |
> | **Optional Parameters** | [events](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70790131), [jql](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70789716), [options](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784233), [description](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70785189) |
> | **Type** | [Create](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70780909/Action+Types#ActionTypes-Create) |
> | **Category** | [Webhooks](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70780591/Action+Categories#ActionCategories-Webhooks) |
> | **Output Formats** |  |
> | **Replacement Variables** | webhookId |
> | **Hosting** | cloud,server,datacenter |
> | **Since Version** | 9.1 |
> | **Examples** | [addWebhook](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70782732/Examples#Examples-addWebhook) |

## Related How To's

> Macro (cql-query)