keys

Get Webhook Secret

The secret your callbacks are signed with, created the first time you ask.

Unlike an API key this can be read back whenever you need it — the platform signs with it, so it is not stored as a hash. Treat it as a credential all the same: anyone holding it can produce a delivery your receiver will accept as genuine.

A signature is sha256= followed by the hex HMAC-SHA256 of <CV-Timestamp>.<body>, computed over the bytes exactly as received. CV-Signature is a comma-separated list — accept the delivery if any value in it matches.

get/v1/webhooks/secret

Request

  • Base URL: https://api.craterview.ai
  • URL: https://api.craterview.ai/v1/webhooks/secret
  • Auth: HTTP bearer

Response

Successful Response

secretstring required

Verify a delivery by computing HMAC-SHA256 of <CV-Timestamp>.<body> under this value and looking for the result among the comma-separated values in CV-Signature.

previousstring nullable

The secret this one replaced, while it is still being sent alongside. Null unless a rotation's window is open.

overlap_ends_in_secondsnumber nullable

How much longer deliveries carry a signature under previous. Null when no rotation is in progress.

Changes

No recorded changes to this operation across all 1 revision of this API.