Partner Webhook Events

The events Everee sends to a partner's webhook endpoints.

Audience: partner. These events are sent to a partner's own partner webhook endpoints in the partner envelope, which has partnerId and no companyId.

Events at a glance

Event typeSent whenDetails
announcement.publishedEveree publishes a technical announcement for partners that build Everee into their productAnnouncement Events
announcement.updatedA published announcement is editedAnnouncement Events
announcement.retractedA published announcement is withdrawnAnnouncement Events
test-event.createdYou call Send a test eventTest event

Events about one of your companies, such as workers and payments, are not partner events. They go to that company's own endpoints. See Company Webhook Events.

Test event

Sent only to the endpoint you test, when you call Send a test event. The endpoint must be enabled.

Webhook event type: test-event.created
Webhook event data.object has the following structure:

{
  "version": "1",
  "id": "abcdef-...",
  "partnerId": 4821,
  "type": "test-event.created",
  "timestamp": 17200110020,
  "data": {
    "object": {
      "testMessage": "This is a test message"
    }
  }
}
FieldMeaning
testMessageA fixed message, This is a test message

Announcement events

Announcement events carry a technical announcement without its full text. They are described, with every field, on Announcement Events. Partners receive each announcement once for the partner, not once per company.


Did this page help you?