Webhooks

Create a webhook endpoint

POST/v1/webhooksrequires webhook:manage

The signing secret is returned once, on creation. Store it: it cannot be read back.

Requestcurl -X POST https://api.transmit.dev/v1/webhooks \
  -H "Authorization: Bearer tr_v2_…" \
  -H "Content-Type: application/json" \
  -d '{
       "name": "…",
       "url": "https://yourdomain.com/webhooks/transmit",
       "events": [
         "…"
       ]
     }'

Body

Field	Type	Notes
`name` required	`string`	1–100 characters
`url` required	`string`	uri
`events` required	`string[]`	at most 50

Responses

Status	Meaning
`201`	The endpoint, including its signing secret
`401`	The API key is missing, malformed, expired or revoked
`403`	The API key lacks the `webhook:manage` scope
`422`	The URL failed validation or is not reachable from the public internet

Every response body is described in the OpenAPI spec, which this page is generated from.