Skip to main content
WEBHOOK

Body

application/json

Sent when a new signal is applied to a company. Delivery is at least once and unordered; ignore fields you do not know.

id
string
required

The event id, also sent as X-Enrik-Event-Id. It never changes across attempts and redeliveries: deduplicate by it.

type
string
required

The event type, also sent as X-Enrik-Event-Type.

Allowed value: "companySignal.created"
version
number
required

The payload version. A breaking change is a new version a subscription opts in to.

occurredAt
string<date-time>
required

When the signal was applied to the company, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
workspaceId
string
required

The workspace the record belongs to.

data
object
required

Which record changed and how; never field values. Read the record for its current state.

Response

200

Answer any 2xx within 10 seconds to acknowledge the event. Anything else, a timeout or a redirect is a failed attempt.