Beignet API reference
Preparing search index...
@beignet/core
webhooks
verifyWebhook
Function verifyWebhook
verifyWebhook
<
TWebhook
extends
WebhookDef
<
string
,
WebhookEventSchemas
>
,
AllowUnknownEvents
extends
boolean
=
false
,
>
(
webhook
:
TWebhook
,
input
:
VerifyWebhookInput
,
options
?:
VerifyWebhookOptions
<
AllowUnknownEvents
>
,
)
:
Promise
<
InferWebhookVerificationResult
<
TWebhook
,
AllowUnknownEvents
>
>
Verify a raw webhook request and validate the matching event payload schema.
Type Parameters
TWebhook
extends
WebhookDef
<
string
,
WebhookEventSchemas
>
AllowUnknownEvents
extends
boolean
=
false
Parameters
webhook
:
TWebhook
input
:
VerifyWebhookInput
options
:
VerifyWebhookOptions
<
AllowUnknownEvents
>
= {}
Returns
Promise
<
InferWebhookVerificationResult
<
TWebhook
,
AllowUnknownEvents
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Beignet API reference
Loading...
Verify a raw webhook request and validate the matching event payload schema.