test

POST /api/admin/hooks/:id/test (hooks.manage, step-up): queues one test event. Audited hooks.test.

Caller and authorization

Staff cookie session; permission hooks.manage; fresh password + TOTP step-up (10 minutes). Write requests need same-origin JSON and X-Admin-CSRF from this session.

This is the private staff console on https://admin.handwrites.io. A personal API key, organisation token, student login or isolated app-testing credential does not authenticate this route.

Request contract

Location	Name	Required	Meaning
path	`id`	Yes	Use the ID from an authorized staff response; source validators reject malformed IDs.
header	`X-Admin-CSRF`	Yes	Session-bound token from the staff page; not a developer credential.

This operation does not define a JSON payload. Staff writes still require Content-Type: application/json and the session-bound CSRF header.

Response and failures

Success: 200. POST /api/admin/hooks/:id/test (hooks.manage, step-up): queues one test event. Audited hooks.test.

The wrapper returns {error:{code,message}} for CloudError failures, attaches Request-Id, and disables caching. Handle 401 by signing in; show role refusal for 403 forbidden, reauthenticate only for step_up_required, and collect a reason for 400 reason_required. A CSRF failure needs a current page/session token, not blind retries. Operation-specific 404/409/413/422/502/503 errors retain their status. Honor Retry-After on 429.

Usage notes

These are staff security/retention webhooks, separate from user document-event webhooks. A create response reveals its signing secret once; store it securely and never include it in docs or logs.

Implementation contract

Source snapshot: admin/src/app/api/admin/hooks/[id]/test/route.ts. This reference describes the current working tree, not proof of deployment. The response service types and validators remain authoritative. The exact exported handler below makes conditional behavior reviewable. For helpers such as customer-routes or cloudRoute, see the shared API specification notes and the named service module.

/** POST /api/admin/hooks/:id/test (hooks.manage, step-up): queues one test event. Audited hooks.test. */
export const POST = adminRoute("hooks.manage", async (_request, ctx, { params }: Context) => adminJson(await testHook(ctx, (await params).id)));

Do not use production customer data to test this operation. Use an authorized staff test account and a disposable target in an appropriate environment; email, deletion, role and credential mutations have real effects.

README — POST /api/admin/hooks/{id}/test

POST /api/admin/hooks/{id}/test#

Caller and authorization#

Request contract#

Response and failures#