Class WebhooksService

Index

Constructors

Methods

constructEvent create delete get list parseEvent update verifySignature

Constructors

constructor

new WebhooksService(
http: HttpClient,
defaultWebhookSecret?: string,
): WebhooksService
Parameters
- http: HttpClient
- OptionaldefaultWebhookSecret: string
Returns WebhooksService
- Defined in src/services/webhooks.ts:14

Methods

constructEvent

constructEvent(
    rawBody: string | Uint8Array<ArrayBufferLike>,
    signatureHeader: string | null | undefined,
    secret?: string,
    toleranceInSeconds?: number,
): Promise<ParsedWebhookEvent>
Construct and verify a webhook event from a raw body string or buffer and signature header. Validates HMAC signature and timestamp tolerance before returning the strongly-typed event.
Parameters
- rawBody: string | Uint8Array<ArrayBufferLike>
  Raw JSON string body or Uint8Array/Buffer from request
- signatureHeader: string | null | undefined
  Value of 'x-marzpay-signature' (or 'x-signature') header
- Optionalsecret: string
  Optional override secret key (defaults to config webhookSecret)
- toleranceInSeconds: number = 300
  Max timestamp drift tolerance (default 300s / 5 minutes)
Returns Promise<ParsedWebhookEvent>
Example
```
const event = await marzpay.webhooks.constructEvent(
  req.rawBody,
  req.headers['x-marzpay-signature']
);
console.log('Received verified webhook:', event.event_type);
```
- Defined in src/services/webhooks.ts:158

create

create(
params: CreateWebhookConfigParams,
): Promise<APIResponseEnvelope<{ webhook: WebhookConfigRecord }>>
Register a new dashboard webhook endpoint.
Parameters
- params: CreateWebhookConfigParams
Returns Promise<APIResponseEnvelope<{ webhook: WebhookConfigRecord }>>
- Defined in src/services/webhooks.ts:29

delete

delete(uuid: string): Promise<APIResponseEnvelope<{ message: string }>>
Delete webhook registration.
Parameters
- uuid: string
Returns Promise<APIResponseEnvelope<{ message: string }>>
- Defined in src/services/webhooks.ts:59

get

get(
uuid: string,
): Promise<APIResponseEnvelope<{ webhook: WebhookConfigRecord }>>
Get webhook registration detail by UUID.
Parameters
- uuid: string
Returns Promise<APIResponseEnvelope<{ webhook: WebhookConfigRecord }>>
- Defined in src/services/webhooks.ts:40

list

list(): Promise<APIResponseEnvelope<{ webhooks: WebhookConfigRecord[] }>>
List registered dashboard webhooks.

Returns Promise<APIResponseEnvelope<{ webhooks: WebhookConfigRecord[] }>>
- Defined in src/services/webhooks.ts:22

parseEvent

parseEvent(payload: string | Record<string, unknown>): ParsedWebhookEvent
Parse and auto-normalize incoming webhook / callback payload. Handles both direct per-request callbacks and dashboard-wrapped webhooks into a strongly-typed event.
Parameters
- payload: string | Record<string, unknown>
  Raw JSON string or parsed JSON object
Returns ParsedWebhookEvent
- Defined in src/services/webhooks.ts:99

update

update(
uuid: string,
params: UpdateWebhookConfigParams,
): Promise<APIResponseEnvelope<{ webhook: WebhookConfigRecord }>>
Update existing webhook registration.
Parameters
- uuid: string
- params: UpdateWebhookConfigParams
Returns Promise<APIResponseEnvelope<{ webhook: WebhookConfigRecord }>>
- Defined in src/services/webhooks.ts:47

verifySignature

verifySignature(
    rawBody: string | Uint8Array<ArrayBufferLike>,
    signatureHeader: string | null | undefined,
    secret?: string,
    timestampHeader?: string | null,
    toleranceInSeconds?: number,
): Promise<boolean>
Verify HMAC signature of an incoming webhook payload.
Parameters
- rawBody: string | Uint8Array<ArrayBufferLike>
  Raw JSON request body string or Uint8Array/Buffer
- signatureHeader: string | null | undefined
  Value of 'x-marzpay-signature' (or 'x-signature') header
- Optionalsecret: string
  Secret key for signing (defaults to config webhookSecret)
- OptionaltimestampHeader: string | null
  Optional value of 'x-marzpay-timestamp' header
- toleranceInSeconds: number = 300
Returns Promise<boolean>
- Defined in src/services/webhooks.ts:71