Hanzo AIDocs
Sign inAPI key

Create secret

Mints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response besides create that ever carries a secret.

POST /v1/webhook/{id}/secret

Webhook → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/webhook/{id}/secret
MethodPOST
Operationpost_webhook_by_id_secret
AuthAuthorization: Bearer $HANZO_API_KEY

Mints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response besides create that ever carries a secret. The old secret stops working the instant this returns: every subsequent delivery signs with the new one, with no overlap window. Call it when the subscriber is ready to swap the value on its side, not before.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyes

Response

StatusBodyMeaning
200webhook.Endpointok
defaultproblem-detailsrefused

200 body — 11 fields.

FieldInTypeAlwaysDescription
createdbodystring—CreatedAt is when the endpoint was registered, RFC3339 in UTC — stored in that spelling because it sorts as a string.
deliveries7dbodyinteger (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.
descriptionbodystring—Description is the operator's own label for the endpoint.
eventsbodystring[]—Events are the subject patterns this endpoint subscribes to ("commerce.order.>").
failures7dbodyinteger (int64)—Failures7d is how many of those settled as failed — the subscriber never accepted it and no further attempt will be made.
idbodystring—ID is the endpoint's handle, server-minted and stable for its life.
orgbodystring—Org is the tenant that owns the endpoint, taken from the validated principal rather than from any request field.
secretbodystring—Secret is the HMAC-SHA256 signing key a subscriber recomputes the signature with.
statusbodystring—Status is "active" or "disabled" — nothing else is accepted.
updatedbodystring—UpdatedAt is when its url, events, status or description last changed.
urlbodystring—URL is where the POST goes.

Failure carries the platform error shape — see Errors.

Examples

hanzo webhook secret <id>
import { Configuration, WebhookApi } from 'hanzoai';

const api = new WebhookApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postWebhookByIdSecret({ 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).post_webhook_by_id_secret(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.WebhookAPI.PostWebhookByIdSecret(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::post_webhook_by_id_secret(&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).postWebhookByIdSecret();
curl -X POST https://api.hanzo.ai/v1/webhook/<id>/secret \
  -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?
PreviousList webhookNextTest webhook