Webhooks
Outgoing webhooks send your organization's task and pull request events to your own HTTPS endpoints. Each delivery is a signed JSON POST: verify X-Jaah-Signature as sha256= plus the hex HMAC-SHA256, keyed by the endpoint's secret, of the X-Jaah-Timestamp value, a dot, and the raw body. Failed deliveries are retried after 1 minute, 5 minutes, 30 minutes, 2, 6 and 12 hours, then marked failed.
List webhooks
Lists the organization's webhook endpoints, oldest first, each with its event types, projects and latest delivery attempt; never a secret. Requires the Org Owner or Org Admin role.
Create webhook
Creates a webhook endpoint and returns it with its webhook `secret`, shown only this once. A URL that is not https or resolves to a private, link-local or metadata address returns 422 `url_refused`; an unknown event type returns 422 `unknown_event_type`, a project outside the organization 422 `unknown_project`, and a 51st endpoint 422 `too_many_endpoints`. Requires the Org Owner or Org Admin role; a plan without webhooks returns 403 `plan`.
List webhook event types
Lists the event types an endpoint may subscribe to, each with its type, name and when it is sent. Requires the Org Owner or Org Admin role.
Delete webhook
Deletes a webhook endpoint and its delivery log. Requires the Org Owner or Org Admin role.
Get webhook
Returns one webhook endpoint with its latest delivery attempt; never its secret. Requires the Org Owner or Org Admin role.
Update webhook
Changes an endpoint's name, description, URL, event types, projects or whether it is enabled; send only the fields to change. A re-enabled endpoint receives events from then on, not the ones missed while it was off. Requires the Org Owner or Org Admin role; a plan without webhooks returns 403 `plan`.
List webhook deliveries
Lists the endpoint's deliveries, newest first, with each one's state, attempts, last status code, latency, error and body; pass `next_cursor` as `cursor` for the next page. Deliveries are kept 30 days. Requires the Org Owner or Org Admin role.
Redeliver webhook delivery
Sends a delivery again now with the same body and `X-Jaah-Delivery`, starting a fresh round of retries, and returns it with the endpoint's answer. At most one test or redelivery per endpoint every 10 seconds; sooner returns 429. Requires the Org Owner or Org Admin role; a plan without webhooks returns 403 `plan`.
Rotate webhook secret
Replaces the endpoint's webhook secret and returns the new `secret`, shown only this once. For 24 hours each delivery also carries a second signature made with the previous secret; rotating again within them ends that overlap. Requires the Org Owner or Org Admin role; a plan without webhooks returns 403 `plan`.
Test webhook
Sends a `ping` delivery to the endpoint now and returns the delivery with the endpoint's answer. At most one test or redelivery per endpoint every 10 seconds; sooner returns 429. Requires the Org Owner or Org Admin role; a plan without webhooks returns 403 `plan`.