Company event

Sent to each of your active webhook endpoints when a monitored company changes: an event (object: "event") whose type is the event type your monitor subscribed to and whose data.object is the alert, exactly as GET /alerts lists it. The body is JSON, sent with Content-Type: application/json.

Deliveries follow the Standard Webhooks scheme: the svix-id, svix-timestamp and svix-signature headers sign the raw body with your endpoint's secret (shown once, when the endpoint is created). svix-id is the event's id; a retry carries it again, so de-duplicate on it. Deliveries can arrive out of order.

Free. Delivering an event costs nothing.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

What your webhook endpoint receives: one event per change and monitor, in the same shape Stripe sends. data.object is the alert exactly as GET /alerts lists it, so one parser serves both. The body is the message exactly as it was signed.

One change that several of your monitors cover arrives once per monitor: different event ids, different alert ids, different monitor_ids.

id*string

The event's id. The same value arrives in the svix-id header, and a retry of this delivery carries it again: deduplicate on it.

object*string

Always event.

type*MonitorEventType

Events a monitor can deliver. * means every event type, including ones added later.

These are the changes monitoring can detect as they happen, which is a subset of the register history at /companies/{company_id}/events and, for shareholders, finer: monitoring reports company.shareholder.added for one shareholder, while the register's own entry appears in the history as company.shareholders.changed for the whole list.

One exception to that subset relationship: company.financial_statement.published has no counterpart in the register history, because an annual financial statement is filed with the Bundesanzeiger rather than entered in the Handelsregister. It reports that a company's newest published statement covers a later period than the newest one previously on file for it. Every other event type here does have a counterpart there; the reverse does not hold.

Value in

"*"
"company.name.changed"
"company.address.changed"
"company.legal_form.changed"
"company.capital.changed"
"company.officer.appointed"
"company.officer.removed"
"company.shareholder.added"
"company.shareholder.changed"
"company.shareholder.removed"
"company.registered_office.changed"
"company.purpose.changed"
"company.liquidation.recorded"
"company.financial_statement.published"

created_at*Timestamp

An instant in UTC, RFC 3339, always with a Z offset.

Match^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?Z$

Formatdate-time

data*

The event's payload.

Response Body

Example Requests

POST/companyEvent

Request Body

Response Body

200

Request Bodyapplication/json