Webhooks

Register a webhook endpoint

The signing secret is in this response and in no other. Store it before you close the connection; it cannot be retrieved afterwards. The URL must be https on port 443 and must resolve to a public address — it is re-checked on every delivery, not only here.

posthttps://api-notetaker.nabrah.ai/ext/v1/webhooks

جسم الطلب

urlstring · uriمطلوب
eventsenum[]مطلوب

الطلب

curl -X POST https://api-notetaker.nabrah.ai/ext/v1/webhooks \
  -H "Authorization: Bearer $NABRAH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "string",
  "events": [
    "meeting.started"
  ]
}'

الاستجابات

201The endpoint, with its signing secret — returned once and never again.
401No key, an unknown key, or one that has been revoked or has expired.
403The key is read only, or lacks the reach for this route.
404No such record — or one that belongs to another account.
422The body or query failed validation; details names the field.
429Too many requests. Retry-After says how long to wait.
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string",
    "events": [
      "string"
    ],
    "status": "active",
    "consecutiveFailures": 0,
    "lastDeliveryAt": "string",
    "lastStatus": 0,
    "disabledReason": "string",
    "createdAt": "2026-01-01T09:00:00.000Z"
  }
}