Webhooks

Subscribe to changes.

List webhook endpoints

GET /webhook-endpoints

Answers

  • 200 object. The caller's webhook endpoints.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Create a webhook endpoint

POST /webhook-endpoints

Sends Idempotency-Key.

SYNC signs every delivery with HMAC-SHA256 in the Vortex-Signature header (t=<unix time>,v1=<hex digest of "t.body">) using the endpoint's secret, which is returned only once, here. Failed deliveries retry with backoff for 3 days. Requires webhooks:write.

Body

FieldTypeAbout
url requiredstring (uri)
events requiredlist of WebhookEventType

Answers

  • 201 any. The endpoint, with its signing secret.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Delete a webhook endpoint

DELETE /webhook-endpoints/{webhook_endpoint_id}

Parameters

NameInTypeAbout
webhook_endpoint_id requiredpathstring

Answers

  • 204 Deleted.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what