Partner Webhooks

Audience: partner. Partner webhooks tell a partner that builds Everee into its own product about things that concern the partnership as a whole, as opposed to one company. Your companies' own events still go to each company's endpoints. For how the two relate, read the Webhooks Overview first.

Partner endpoints

A partner can have up to three partner endpoints. You manage them yourself with your partner API key, using the Partner Webhook Endpoints API: create, list, change, switch off, delete, rotate the signing key, and send a test event. A company API key is refused. Everee staff can see your endpoints and what was delivered to them, to help with support, but cannot create or change them.

Each endpoint has its own signing key, starting with psk_. It is shown in full once, when you create the endpoint or rotate its key, and masked after that.

The partner envelope

Partner events identify the partner instead of a company. partnerId is always present and companyId never is. Every request has the header x-everee-webhook-audience: partner.

{
  "version": "1",
  "id": "abcdef-...",
  "partnerId": 4821,
  "type": "announcement.published",
  "timestamp": 17200110020,
  "data": {
    "object": { }
  }
}

Field	Meaning
`version`	Version of the envelope structure. Currently always `"1"`
`id`	The event's unique ID. Use it to skip duplicates
`partnerId`	Your partner ID in Everee
`type`	The event type, such as `announcement.published`
`timestamp`	Epoch timestamp of when the event occurred
`data.object`	The event's payload. Each event type documents its own structure

The envelope is defined as a JSON Schema.

Setting up a partner endpoint

Create the endpoint and store the signingKey from the response.
Build your handler to verify the signature, to read partnerId rather than companyId, and to follow the handler rules.
Send a test event and check that your handler accepts it. The test event is a test-event.created partner event sent to that endpoint only.
Keep the endpoint enabled. A disabled endpoint receives nothing, and can't be sent a test event.

Signing, retries, replay protection and rotation work exactly as they do for company webhooks. See the Webhooks Overview.

Events

The events a partner endpoint receives are listed in Partner Webhook Events.