WebhookInboundClient constructor

Construct a standalone WebhookInboundClient with new WebhookInboundClient() using only a secret, no API key, for inbound signature checks.

Example

import { WebhookInboundClient } from "@alhwyn/luma";

const webhook = new WebhookInboundClient({
  secret: process.env.LUMA_WEBHOOK_SECRET!,
});

Response

const webhook: WebhookInboundClient;

SDK new WebhookInboundClient(options: WebhookInboundClientOptions): WebhookInboundClient

Creates a standalone inbound client without an API key.

Example

import { WebhookInboundClient } from "@alhwyn/luma";

const webhook = new WebhookInboundClient({
  secret: process.env.LUMA_WEBHOOK_SECRET!,
});

Response

const webhook: WebhookInboundClient;

Parameters

options · WebhookInboundClientOptions · required

Inbound client configuration.

Show WebhookInboundClientOptions properties

secret · string · required

Webhook signing secret from webhooks.create().

tolerance · number

Optional timestamp tolerance in seconds for signature verification.

Test it

const webhook = new WebhookInboundClient({
  secret: process.env.LUMA_WEBHOOK_SECRET!,
});
console.log("Inbound client ready");

Or create via the resource factory:

const webhook = new Luma(process.env.LUMA_API_KEY!).webhooks.client({
  secret: process.env.LUMA_WEBHOOK_SECRET!,
});