Skip to main content
PUT
Set the webhook endpoint

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Keys are stored hashed and cannot be recovered; store them in your secrets manager on issue.

Headers

Idempotency-Key
string

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

Maximum string length: 255

Body

application/json
url
string<uri>
required

HTTPS endpoint that receives events.

Example:

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

Response

Endpoint registered. The secret is shown exactly once.

url
string<uri>
required
secret
string
required

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

Example:

"whsec_4f8a1c2b9d3e6f7a8b9c0d1e2f3a4b5c"