# Replace webhooks

URL: https://docs.hanzo.ai/docs/openapi/form/replace-form-webhook

> Replaces a webhook's tag, address and whether it is enabled.

`PUT /v1/form/forms/{id}/webhooks/{webhook}`

> [Form →](https://docs.hanzo.ai/docs/openapi/form) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                              |
| ------------- | ------------------------------------------------------------ |
| **Address**   | `https://api.hanzo.ai/v1/form/forms/{id}/webhooks/{webhook}` |
| **Method**    | `PUT`                                                        |
| **Operation** | `replace_form_webhook`                                       |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                       |

Replaces a webhook's tag, address and whether it is enabled. A secret given is
kept in place of the one held, rotate mints a new one, and either is answered
once; otherwise the secret held stays. An org admin only.

## Request

9 fields, body `application/json` (required).

| Field     | In   | Type    | Required | Description                                               |
| --------- | ---- | ------- | -------- | --------------------------------------------------------- |
| `id`      | path | string  | yes      | ID is the form's id or slug, from the path.               |
| `webhook` | path | string  | yes      | Webhook is the webhook's id, from the path of a replace.  |
| `enabled` | body | boolean | —        | Enabled is whether responses are posted.                  |
| `id`      | body | string  | —        | ID is the form's id or slug, from the path.               |
| `rotate`  | body | boolean | —        | Rotate mints a new secret on a replace, and answers it.   |
| `secret`  | body | string  | —        | Secret sets the signing secret: 16 to 256 characters.     |
| `tag`     | body | string  | —        | Tag names the webhook in its form, at most 64 characters. |
| `url`     | body | string  | —        | URL is the https address posted to.                       |
| `webhook` | body | string  | —        | Webhook is the webhook's id, from the path of a replace.  |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | form.Webhook    | ok      |
| `default` | problem-details | refused |

`200` body — 8 fields.

| Field     | In   | Type    | Always | Description                                                                                            |
| --------- | ---- | ------- | ------ | ------------------------------------------------------------------------------------------------------ |
| `created` | body | string  | —      | Created is when the webhook was made, RFC 3339.                                                        |
| `enabled` | body | boolean | —      | Enabled is whether responses are posted.                                                               |
| `form`    | body | string  | —      | Form is the form's id.                                                                                 |
| `id`      | body | string  | —      | ID is the webhook's id.                                                                                |
| `secret`  | body | string  | —      | Secret is the signing secret, answered once: when the webhook is made or its secret is set or rotated. |
| `tag`     | body | string  | —      | Tag names the webhook in its form.                                                                     |
| `updated` | body | string  | —      | Updated is when it last changed, RFC 3339.                                                             |
| `url`     | body | string  | —      | URL is the https address posted to.                                                                    |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo form forms webhooks set <id> <webhook>
```

**SDK**

**.ts**

```ts
import { Configuration, FormApi } from 'hanzoai';

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.replaceFormWebhook({ id: 'id', webhook: 'webhook', enabled: false, id: "<id>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FormApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FormApi(client).replace_form_webhook(id='id', webhook='webhook', enabled=False, id="<id>")
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FormAPI.ReplaceFormWebhook(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, form_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = form_api::replace_form_webhook(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FormApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FormApi(client).replaceFormWebhook();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl -X PUT https://api.hanzo.ai/v1/form/forms/<id>/webhooks/<webhook> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "enabled": false,
       "id": "<id>"
     }'
```

**MCP**

Tool `form`, op `replace_form_webhook` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "form",
         "arguments": {
           "op": "replace_form_webhook",
           "input": {
             "id": "<id>",
             "webhook": "<webhook>",
             "enabled": false
           }
         }
       }
     }'
```

---

[Form API](https://docs.hanzo.ai/docs/openapi/form) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)