Function: verify()

verify(secret, signature, body): boolean

Defined in: rest/v2/webhooks/verify.ts:15

Verify an incoming webhook request

Parameters

secret

string

The webhook secret. Can be found in the portal or in the API response for client webhooks

signature

The signature of the request. Can be found in the request headers

null | string

body

string

The raw request body

Returns

boolean

whether the signature is valid for the associated body

Throws

if no secret is given