Webhook events

We may add new event types at any time. Ignore any event type your application does not recognize, and still respond with a 2xx status. You only receive the events you are subscribed to (see Event subscriptions).

Cyber Risk Score Ready

cyber_risk_score_ready

Occurs when the Cyber Scan has completed on the client and their Corvus score is available. Clients are rescanned periodically, so this event can occur more than once for the same client.

{  "data": {    "brokerageId": "Yb3kP0aLQx2s8vN1dWqZeA",    "clientId": {      "id": "TiAtsfd-R2S92Svs1ludyw"    }  },  "timestamp": 1601414395,  "type": "cyber_risk_score_ready"}

Payload envelope

{  "data": JSON Object,  "timestamp": Unix Timestamp,  "type": String}

Every event's data includes brokerageId.

See Subscribe and verify.

Verify the signature

X-CrowBar-Signature: t=1601414395,s=wGpXVnQVScPh5n7nS63z4MBSc6kCQuefjGNvJy86Fzw=

Take the signature after s=.
Compute an HMAC-SHA256 of the raw request body, keyed with your API key.
Compare. A match means the webhook came from Corvus.

Regenerating your API key changes the signing key immediately.

See Subscribe and verify.

Delivery and retries

Any 2xx acknowledges. Other statuses fail; redirects aren't followed.
15 s to connect, 15 s to respond.
Retried every 5 minutes, 10 attempts in total.
At-least-once and unordered. Make handlers idempotent and re-query the resource.
Events you aren't subscribed to are skipped, not retried.

See Delivery and retries.

Source IPs to allowlist

The full section is available to partners who are signed in to the Developer Portal.

Access is by invitation. To request it, email api@corvusinsurance.com.