Skip to main content
WEBHOOK
data has the keys of an announcement in the Announcements API, in the same order, and then the webhook extra country. ai_insights is always null in this event, because the summary does not exist yet. When the summary is ready, you get announcement.summary.created with the same data.id.
data.id is not the same value as the id of an announcement in the API:
  • Webhook data.id: the StockInsights id of the announcement.
  • API id: the id that the exchange gave the announcement.
Do not match a webhook announcement to an API announcement by id.

Headers

webhook-id
string
required

The event id. It is the same as id in the body. Every retry of an event has the same id.

webhook-timestamp
string
required

When the request was signed, in UNIX seconds.

webhook-signature
string
required

The signature: v1, and a base64 HMAC-SHA256. See Authentication.

X-StockInsights-Event
string
required

The event type.

X-StockInsights-Delivery
string
required

The id of one event going to one destination. Every retry has the same id.

Body

application/json
id
string
required

The event id: evt_ and a UUID. It is also the webhook-id header. The same event can arrive more than once, so de-duplicate on this id.

Pattern: ^evt_[0-9a-f-]{36}$
type
string
required

The event type.

Allowed value: "announcement.created"
api_version
string
required

Always v2.

Allowed value: "v2"
occurred_at
string<date-time>
required

When the event happened, as an ISO 8601 timestamp in UTC.

data
object
required

The API object of the filing, plus the webhook extras.

Response

200

Return any 2xx status within 10 seconds to accept the event. Any other status, a timeout or a connection error is retried.