List webhook

Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts.

GET /v1/webhook

Webhook → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/webhook`
Method	`GET`
Operation	`get_webhook`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts. Signing secrets are redacted here — a secret leaves the server only on create and on rotate. The listing is physically org-scoped, so another tenant's endpoints are not reachable from this route at all.

Request

GET /v1/webhook takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	webhook.endpointList	ok
`default`	problem-details	refused

200 body — 12 fields.

Field	In	Type	Always	Description
`data`	body	webhook.Endpoint[]	—	Data is the org's endpoints, newest first, each with its signing secret REDACTED — the secret leaves the server only on create and on rotate.
`data[].created`	body	string	—	CreatedAt is when the endpoint was registered, RFC3339 in UTC — stored in that spelling because it sorts as a string.
`data[].deliveries7d`	body	integer (int64)	—	Deliveries7d is how many deliveries SETTLED in the trailing 7 days — the attempts that ended ok or failed, so a delivery still retrying is in neither counter yet.
`data[].description`	body	string	—	Description is the operator's own label for the endpoint.
`data[].events`	body	string[]	—	Events are the subject patterns this endpoint subscribes to ("commerce.order.>").
`data[].failures7d`	body	integer (int64)	—	Failures7d is how many of those settled as failed — the subscriber never accepted it and no further attempt will be made.
`data[].id`	body	string	—	ID is the endpoint's handle, server-minted and stable for its life.
`data[].org`	body	string	—	Org is the tenant that owns the endpoint, taken from the validated principal rather than from any request field.
`data[].secret`	body	string	—	Secret is the HMAC-SHA256 signing key a subscriber recomputes the signature with.
`data[].status`	body	string	—	Status is "active" or "disabled" — nothing else is accepted.
`data[].updated`	body	string	—	UpdatedAt is when its url, events, status or description last changed.
`data[].url`	body	string	—	URL is where the POST goes.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo webhook list

.ts

.py

.go

.rs

.java

import { Configuration, WebhookApi } from 'hanzoai';

const api = new WebhookApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getWebhook();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import WebhookApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = WebhookApi(client).get_webhook()

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

resp, _, err := client.WebhookAPI.GetWebhook(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, webhook_api};

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

let result = webhook_api::get_webhook(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.WebhookApi;

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

var result = new WebhookApi(client).getWebhook();

curl https://api.hanzo.ai/v1/webhook \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches webhook through the webhook tool, which names its 7 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_webhooks"
         }
       }
     }'

Webhook API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet webhook NextCreate secret