List deliveries

Lists a webhook's deliveries, newest first: each response posted, how many attempts it took, the last status the address answered and why it failed.

GET /v1/form/forms/{id}/webhooks/{webhook}/deliveries

Form → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/form/forms/{id}/webhooks/{webhook}/deliveries`
Method	`GET`
Operation	`list_form_deliveries`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists a webhook's deliveries, newest first: each response posted, how many attempts it took, the last status the address answered and why it failed. An org admin only.

Request

4 fields.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the form's id or slug, from the path.
`webhook`	path	string	yes	Webhook is the webhook's id, from the path.
`page`	query	integer	—	Page is the page, from 1; PageSize at most 200, default 50.
`page_size`	query	integer	—

Response

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

200 body — 14 fields.

Field	In	Type	Always	Description
`items`	body	form.Delivery[]	—
`items[].attempts`	body	integer (int64)	—	Attempts is how many posts were made.
`items[].code`	body	integer (int64)	—	Code is the last HTTP status the address answered; 0 when it did not answer.
`items[].created`	body	string	—	Created is when the first attempt was made, RFC 3339.
`items[].error`	body	string	—	Error is why the last attempt failed.
`items[].id`	body	string	—	ID is the delivery's id; the body carries it as event_id.
`items[].next`	body	string	—	Next is when the next attempt is due, RFC 3339; empty when none is.
`items[].response`	body	string	—	Response is the response's id.
`items[].status`	body	string	—	Status is delivered, retrying or failed.
`items[].updated`	body	string	—	Updated is when the last was, RFC 3339.
`items[].webhook`	body	string	—	Webhook is the webhook's id.
`page`	body	integer (int64)	—
`page_size`	body	integer (int64)	—
`total`	body	integer (int64)	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo form forms webhooks deliveries list <id> <webhook>

.ts

.py

.go

.rs

.java

import { Configuration, FormApi } from 'hanzoai';

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listFormDeliveries({ id: 'id', webhook: 'webhook' });

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_deliveries(id='id', webhook='webhook')

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

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

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_deliveries(&cfg, Default::default()).await?;

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).listFormDeliveries();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (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 →

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

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

Form API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousImport forms NextList responses