Management API / Events

Register a webhook

POST/api/manage/v1/webhooks

Registers a webhook endpoint owned by this key. The signing secret is returned once.

Authorization

Authorizationheaderrequired
Bearer jfk_…: an API key created in Admin → Settings → API.
Required capabilitysettings:manage
The key and its owner must both hold it. Content scopes on the key are applied to this request as well.

Body

application/json

namestringrequired
1–120 characters.
urlstringrequired
The HTTPS endpoint to deliver to.
eventsstring[]required
1–100 event names from List events.
activeboolean

Response

201Created — secret shown once
401Missing, unknown, revoked, expired, or out-of-scope key.
403The key or its owner lacks the required capability or scope.
429Per-key or per-IP rate limit exceeded. Wait for the seconds in Retry-After.

curl -X POST "https://your-site.example/api/manage/v1/webhooks" \
  -H "Authorization: Bearer $JF_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"CI deploy","url":"https://ci.example/hooks/justflows","events":["content.published","content.unpublished"]}'

Response

{
  "endpoint": {
    "id": "0192d420-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
    "name": "CI deploy",
    "url": "https://ci.example/hooks/justflows",
    "events": [
      "content.published",
      "content.unpublished"
    ],
    "active": true,
    "createdAt": "2026-10-01T10:00:00.000Z",
    "updatedAt": "2026-10-01T10:00:00.000Z"
  },
  "secret": "whsec_…"
}