Create a webhook
Subscribes a public https address to events and returns the signing secret, which GET /v1/webhooks/{webhook_id} also shows. A webhook stops working when the key that made it is revoked or expires, and an account may have up to 20. Deliveries are described by the WebhookEvent schema: a {id, type, created_at, data} body signed in X-Jobbit-Signature.
Requires the webhooks:write permission.
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer jb_live_…
Body
A public https address. It is resolved and checked on every delivery, and redirects are not followed. Addresses with a user name, password or fragment, and private addresses, are refused.
9 - 2000The events to send. The key must be able to read what each event carries: agent:read for agent_task.finished, deploy:read for the deployment events, account:read for balance.low, automations:read for automation_run.finished.
1 - 5 elementsagent_task.finished, deployment.succeeded, deployment.failed, balance.low, automation_run.finished A note for yourself.
200For balance.low: send the event when the balance falls below this many credits. Defaults to 100. Needs balance.low in events.
"250"
Response
The webhook, with its signing secret.
The webhook id.
^wh_[a-z0-9]{20}$Where events are sent.
The events it receives.
agent_task.finished, deployment.succeeded, deployment.failed, balance.low, automation_run.finished The key that made the webhook. The webhook works only while this key does, and only hears about the apps and workspaces the key may see.
False once the key has been revoked or has expired.
When it was made.
The signing secret, starting with whsec_. Use it to check X-Jobbit-Signature on each delivery. Keep it private.
Your note.
The balance.low threshold in credits. Null if the webhook does not take balance.low.