hooks

Create a capture hook

Mints a public ingest URL (on a dedicated utility host, never the brand or API origin). Any HTTP request sent there is recorded and answered with a fixed 200 {"ok":true} — responses are not configurable. Creation shares the burst-10 creation bucket with inboxes. Captured requests are hard-capped per plan (free 100/mo, solo 2,500, team 15,000, scale 100,000; daily caps 100/2,000/10,000/50,000) — over-cap ingest answers 429 with Retry-After. Captures never fire outbound webhook events (loop prevention, by design).

post/v1/hooks

Request

  • Base URL: https://api.mailfixture.com
  • URL: https://api.mailfixture.com/v1/hooks
  • Auth: HTTP bearer

Request body

labelstring

Human label shown in lists and the dashboard.

ttl_secondsinteger

Auto-delete the hook (and its captured requests) after this many seconds (max 30 days). Omit for no expiry.

Response

Hook created; ingest_url is the address to give the app under test.

created_atstring date-time required
idstring uuid required
ingest_urlstring required

The public URL to configure in the app under test. Any method; bodies up to 256KB. Successful captures always answer the fixed 200 {"ok":true} — responses are not configurable; over-size bodies answer 413, exhausted quotas 429 with Retry-After, and an unknown token 404.

labelstring nullable required
tokenstring required

The write capability embedded in the ingest URL. Anyone who knows it can add requests to the bin — treat like a webhook secret. It never grants reads.

ttl_expires_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.