# List webhooks

URL: https://docs.hanzo.ai/docs/openapi/form/list-form-webhooks

> Lists a form's webhooks.

`GET /v1/form/forms/{id}/webhooks`

> [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` |
| **Method**    | `GET`                                              |
| **Operation** | `list_form_webhooks`                               |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`             |

Lists a form's webhooks. Secrets are never read back. An org admin only.

## Request

1 field.

| Field | In   | Type   | Required | Description                                     |
| ----- | ---- | ------ | -------- | ----------------------------------------------- |
| `id`  | path | string | yes      | ID is the form's id or its slug, from the path. |

## Response

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

`200` body — 9 fields.

| Field             | In   | Type            | Always | Description                                                                                            |
| ----------------- | ---- | --------------- | ------ | ------------------------------------------------------------------------------------------------------ |
| `items`           | body | form.Webhook\[] | —      |                                                                                                        |
| `items[].created` | body | string          | —      | Created is when the webhook was made, RFC 3339.                                                        |
| `items[].enabled` | body | boolean         | —      | Enabled is whether responses are posted.                                                               |
| `items[].form`    | body | string          | —      | Form is the form's id.                                                                                 |
| `items[].id`      | body | string          | —      | ID is the webhook's id.                                                                                |
| `items[].secret`  | body | string          | —      | Secret is the signing secret, answered once: when the webhook is made or its secret is set or rotated. |
| `items[].tag`     | body | string          | —      | Tag names the webhook in its form.                                                                     |
| `items[].updated` | body | string          | —      | Updated is when it last changed, RFC 3339.                                                             |
| `items[].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 list <id>
```

**SDK**

**.ts**

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

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listFormWebhooks({ 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).list_form_webhooks(id='id')
```

**.go**

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

resp, _, err := client.FormAPI.ListFormWebhooks(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::list_form_webhooks(&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).listFormWebhooks();
```

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 https://api.hanzo.ai/v1/form/forms/<id>/webhooks \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `form`, op `list_form_webhooks` — 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": "list_form_webhooks",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'
```

---

[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)