The Partner Webhook Endpoints API lets a partner manage where Everee sends partner events: events about the partner as a whole, such as announcements, as opposed to the events of each company, which go to that company's own webhook endpoints. A partner can have up to three endpoints, and every partner event is sent to each enabled one.
| Endpoint | What it does |
|---|---|
| List partner webhook endpoints | Lists your endpoints |
| Get a partner webhook endpoint | Returns one endpoint |
| Create a partner webhook endpoint | Adds an endpoint and returns its signing key |
| Update a partner webhook endpoint | Changes its name, URL, or whether it is enabled |
| Delete a partner webhook endpoint | Removes an endpoint |
| Rotate a partner signing key | Issues a new signing key |
| Send a test event | Sends a test event to an endpoint |
These endpoints use your partner API key, like the rest of the Company Onboarding API. A company API key is refused. Everee staff can see your endpoints and what was delivered to them, to help with support, but only you create and change them.
They are served under /integration/v1/partner/webhook-endpoints.
What arrives at a partner endpoint
Partner events use the partner envelope, which has partnerId and no companyId, and every request has the header x-everee-webhook-audience: partner. Requests are signed exactly as company events are: see Authenticating events. Use the signing key of the endpoint that received the request.
- Partner Webhooks: the partner envelope, setup, and how partner webhooks differ from company webhooks.
- Partner Webhook Events: the events a partner endpoint receives. Today these are the announcement events and the test event.
- Webhook JSON Schemas: to validate what you receive.
An endpoint
| Field | Meaning |
|---|---|
id | The endpoint's ID, used in every other path |
name | A label for the endpoint |
url | The https URL events are sent to |
enabled | Whether Everee sends events to this endpoint |
signingKey | The key for verifying events. Shown in full only when you create the endpoint or rotate its key, and masked otherwise |
previousSigningKeyExpiresAt | After a rotation, until when the replaced key still signs events |
createdAt | When the endpoint was created |
The URL rules, the signing key and rotation, and switching an endpoint off all work as they do for company endpoints: see the Webhook Endpoints API guide. A partner endpoint's signing key starts with psk_.
Setting up an endpoint
- Create the endpoint and store the
signingKeyfrom the response. - Build your handler to verify the signature, and to accept the partner envelope.
- Send a test event and check that your handler accepts it.