WebhookData
Defined in: packages/analytics/src/collectors/webhook.collector.ts:9
Properties
Section titled “Properties”
optionalbody?:any
Defined in: packages/analytics/src/collectors/webhook.collector.ts:20
The parsed payload that the transformers read, required while signature
validation is off. While it is on, the collector parses it from the
verified rawBody instead, so it can be omitted and a value passed here
is replaced.
headers
Section titled “headers”headers:
Record<string,string>
Defined in: packages/analytics/src/collectors/webhook.collector.ts:13
id:
string
Defined in: packages/analytics/src/collectors/webhook.collector.ts:10
rawBody?
Section titled “rawBody?”
optionalrawBody?:string|ArrayBuffer|Uint8Array<ArrayBufferLike>
Defined in: packages/analytics/src/collectors/webhook.collector.ts:29
The request body exactly as received, before any parsing: the bytes the
sender signed. Prefer bytes, such as await request.arrayBuffer();
request.text() drops a leading BOM and replaces invalid UTF-8.
Required while signature validation is on, and then it must be UTF-8
JSON. Its size in bytes counts against maxPayloadSize before the
signature is checked.
signature?
Section titled “signature?”
optionalsignature?:string
Defined in: packages/analytics/src/collectors/webhook.collector.ts:31
The signature to check when the signature header is missing.
source
Section titled “source”source:
string
Defined in: packages/analytics/src/collectors/webhook.collector.ts:11
timestamp
Section titled “timestamp”timestamp:
Date
Defined in: packages/analytics/src/collectors/webhook.collector.ts:12