Get webhook

Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.

GET /v1/webhook/{id}

Webhook → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/webhook/{id}`
Method	`GET`
Operation	`get_webhook_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted. An id another org owns reads as not found, so the response cannot confirm that it exists.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes

Response

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

200 body — 11 fields.

Field	In	Type	Always	Description
`created`	body	string	—	CreatedAt is when the endpoint was registered, RFC3339 in UTC — stored in that spelling because it sorts as a string.
`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.
`description`	body	string	—	Description is the operator's own label for the endpoint.
`events`	body	string[]	—	Events are the subject patterns this endpoint subscribes to ("commerce.order.>").
`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.
`id`	body	string	—	ID is the endpoint's handle, server-minted and stable for its life.
`org`	body	string	—	Org is the tenant that owns the endpoint, taken from the validated principal rather than from any request field.
`secret`	body	string	—	Secret is the HMAC-SHA256 signing key a subscriber recomputes the signature with.
`status`	body	string	—	Status is "active" or "disabled" — nothing else is accepted.
`updated`	body	string	—	UpdatedAt is when its url, events, status or description last changed.
`url`	body	string	—	URL is where the POST goes.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo webhook get <id>

.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.getWebhookById({ id: 'id' });

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_by_id(id='id')

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

resp, _, err := client.WebhookAPI.GetWebhookById(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_by_id(&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).getWebhookById();

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

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

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": "webhook",
         "arguments": {
           "op": "get_webhook_by_id",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

Webhook API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList deliveries NextList webhook