Hanzo AIDocs
Sign inAPI key

List deliveries

Returns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the subscriber answered, and how long it took.

GET /v1/webhook/{id}/deliveries

Webhook → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/webhook/{id}/deliveries
MethodGET
Operationget_webhook_by_id_deliveries
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the subscriber answered, and how long it took. One event that retried three times appears as three rows sharing a delivery id. It is org-scoped exactly like every other route here: the endpoint lookup only ever finds THIS org's endpoint, so another org's id is a 404 and never a window onto its logs.

Request

3 fields.

FieldInTypeRequiredDescription
idpathstringyes
limitqueryinteger—Limit caps how many attempts come back: default 50, maximum 200.
statusquerystring—Status narrows the log to one outcome: "ok", "retrying" or "failed".

Response

StatusBodyMeaning
200webhook.deliveryListok
defaultproblem-detailsrefused

200 body — 10 fields.

FieldInTypeAlwaysDescription
databodywebhook.DeliveryRow[]—Data is the matching attempts, newest first.
data[].attemptbodyinteger (int64)—Attempt is which try this row is, starting at 1.
data[].createdbodystring—Created is when the attempt was made, RFC3339 in UTC.
data[].deliverybodystring—DeliveryID groups the attempts for ONE event to ONE endpoint.
data[].durationMsbodyinteger (int64)—DurationMs is how long this attempt took end to end, in MILLISECONDS.
data[].endpointbodystring—EndpointID is which subscriber this attempt was for.
data[].errorbodystring—Error says what went wrong on a non-ok attempt.
data[].httpStatusbodyinteger (int64)—HTTPStatus is what the subscriber answered.
data[].statusbodystring—Status is "ok" when the subscriber accepted it, "retrying" while a further attempt will follow, and "failed" when none will.
data[].subjectbodystring—Subject is the event that was delivered ("commerce.order.created").

Failure carries the platform error shape — see Errors.

Examples

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

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

resp, _, err := client.WebhookAPI.GetWebhookByIdDeliveries(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_deliveries(&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).getWebhookByIdDeliveries();
curl https://api.hanzo.ai/v1/webhook/<id>/deliveries \
  -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?
PreviousDelete webhookNextGet webhook