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. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Headers

Idempotency-Key
string

Any non-empty string; deterministic keys from your own IDs work best. Repeating the same key with the same body on the same endpoint and mode within 24 hours returns the stored successful response (with Idempotent-Replay: true) instead of re-executing. Error responses are not stored.

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
mode
enum<string>
required

The mode whose endpoint was set, from the calling key.

Available options:
test,
live
secret
string
required

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

Example:

"whsec_4f8a1c2b9d3e6f7a8b9c0d1e2f3a4b5c"