Skip to main content
PUT
Setup Partner Webhook

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

category
enum<string>
required

Category of partner webhook.

Available options:
payroll_status

Body

application/json

Body accepted on the admin setup (PUT) request.

The secret is NOT accepted from the caller — the server generates it (see PartnerWebhookService) and returns it once.

url
string<uri>
required

HTTPS endpoint we POST events to

Required string length: 1 - 2083
enabled
boolean
default:true

Response

Successful Response

Response for setup (first PUT) and rotate: the generated secret is shown once.

secret is null on a repeat PUT that only updates url/enabled without minting a new key.

partner_id
string
required

Auth0 client_id of the partner

category
enum<string>
required

Event category, e.g. payroll_status

Available options:
payroll_status
enabled
boolean
required

Whether deliveries are sent for this webhook

url
string<uri>
required

HTTPS endpoint we POST events to

Required string length: 1 - 2083
secret
string | null

Signing secret — shown once, store it now