v1

latestOpenAPI 3.1.02026-07-22191956.7 KB

Webhooks

Set the webhook endpoint

Registers (or replaces) your HTTPS webhook endpoint. The signing secret is returned once and stored encrypted; save it immediately. Rotating: call this endpoint again to get a new secret.

put/webhook

Headers

Idempotency-Keystring

Any unique string (UUIDs work well). Replaying the same key within 24 hours returns the stored response instead of re-executing the request.

Request body

urlstring uri required

HTTPS endpoint that receives events.

Example request

{
  "url": "https://api.example-hr.com/webhooks/prescience"
}

Response

Endpoint registered. The secret is shown exactly once.

urlstring uri required

secretstring required

Signing secret, whsec_<hex>. Returned only on this response.

Example response

{
  "secret": "whsec_4f8a1c2b9d3e6f7a8b9c0d1e2f3a4b5c"
}