SeamWebhook.md

seamapi / Exports / SeamWebhook

Class: SeamWebhook

Parse and verify webhook payloads.

Table of contents

Constructors

• constructor

Properties

• wh

Methods

• verify

Constructors

constructor

• new SeamWebhook(secret)

Create a new instance of SeamWebhook.

Parameters

Name	Type	Description
secret	string	your webhook secret from the dashboard

Defined in

src/webhooks.ts:14

Properties

wh

• Private wh: Webhook

Defined in

src/webhooks.ts:8

Methods

verify

▸ verify(payload, headers): SeamWebhookEvent

Verify a payload received from a webhook and return the typed event.

Parameters

Name	Type	Description
payload	string	must be a string (should not be the parsed JSON object)
headers	Record<string, string>	request headers (used to verify against the secret)

Returns

SeamWebhookEvent

event

Defined in

src/webhooks.ts:24