Set up webhooks
Prio tells your server when something changes for one of your users. Add your webhook URL on the Keys tab of your console. The first time you save one, Prio creates your signing secret; it starts whsec_ and is shown once at the head of the Keys tab. If you miss it, choose Replace the webhook secret on the same tab to issue a new one.
What Prio sends
| Event | data | When |
|---|---|---|
| user.status_changed | userId, status, previousStatus | a user’s approval status changed |
| invoice.created | the invoice | an invoice was made |
| invoice.updated | the invoice | an invoice’s status, amount, prices or due date changed |
Answer quickly
Respond with any 2xx within 15 seconds, then do the work. Anything else — a timeout or a redirect included — counts as a failure and Prio tries again (Signatures and retries). The URL must be https, and Prio never follows a redirect.
The address
The address must be https and at most 2,048 characters, and its host cannot be an internal name or address, or a disguised numeric spelling. http://localhost is allowed only in development.
Changing the address or secret
Replacing the secret signs webhooks already queued with the new one. Clearing the address drops the webhooks still queued.
Which events reach you
A draft invoice sends invoice.created too. An invoice notice goes to one partner at most: the payer's partner when the payer is a partner's customer, otherwise the payee's. When that partner has no webhook address, nothing is sent.
Nothing is sent again after about 27 hours of retries; read the invoices to catch up. Your console's Keys tab lists recent deliveries.