Skip to main content
WEBHOOK
data has the keys of a document in the Filings API, in the same order, and then the webhook extras country, file_link, transcript and recording. An event is sent only for the transcript of a results call with a known year and quarter. Thus form_type is always earnings-transcript and quarter is never null. The transcript must also be published at most 7 days before the event. The transcript can be one of two kinds:
  • Official: the company published it. transcript.type is official, and the PDF is in pdf_link.
  • Machine-made: StockInsights made it from the call recording, because the company did not publish a transcript yet. transcript.type is machine_transcribed, and our PDF is in file_link.
When the official transcript or the recording arrives later, you get earnings-transcript.updated.

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: "earnings-transcript.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.