---
title: "addWebhook"
canonical: "https://support.appfire.com/space/SCLI/73370301/addWebhook"
format: markdown
---
See also: [Actions](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368507)

> 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 disable to disable the webhook. Use --options "secret=..." to set a data integrity verification string. For Post Webhooks for Bitbucket users, use '--options postWebhooks'. |
> | --- | --- |
> | **Required Parameters** | [project](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368805), [repository](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368867), [name](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368765), [url](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371525) |
> | **Optional Parameters** | [events](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371044), [options](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371383), [field](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371343) |
> | **Type** | [Create](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370540/Action+Types#ActionTypes-Create) |
> | **Category** | [Webhooks](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371318/Action+Categories#ActionCategories-Webhooks) |
> | **Output Formats** |  |
> | **Replacement Variables** | project, projectId, repository, repositoryId, repositoryName, webhook, webhookId |
> | **Hosting** | cloud,server,datacenter |
> | **Since Version** | 9.6 |
> | **Examples** | [addWebhook](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371753/Examples#Examples-addWebhook) |

## Related How To's

> Macro (cql-query)