WebhookHandlerConfig

SIP Protocol API Reference v0.7.4

---

SIP Protocol API Reference / WebhookHandlerConfig

Interface: WebhookHandlerConfig

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16055

Configuration for the Helius webhook handler

Security

This config contains sensitive cryptographic keys. Never log, store in plain text, or transmit insecurely.

Properties

viewingPrivateKey

viewingPrivateKey: `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16063

Recipient’s viewing private key (hex)

Security

SENSITIVE - This key enables detection of incoming payments. Store securely (encrypted). Never log or expose in error messages. Use environment variables or secure vault in production.

---

spendingPublicKey

spendingPublicKey: `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16065

Recipient’s spending public key (hex)

---

onPaymentFound()

onPaymentFound: (payment) => void | Promise<void>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16071

Callback when a payment is found

Parameters

payment

SolanaScanResult

The detected payment details

Returns

void | Promise<void>

---

onError()?

optional onError: (error, transaction?) => void

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16078

Optional callback for errors

Parameters

error

Error

The error that occurred

transaction?

HeliusWebhookTransaction

The transaction that caused the error (if available)

Returns

void

---

webhookSecret?

optional webhookSecret: string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16088

Webhook authentication secret (recommended for production)

When set, the handler will verify the X-Helius-Signature header using HMAC-SHA256 to ensure webhook payloads are authentic.

Get your webhook secret from Helius Dashboard: https://dev.helius.xyz/webhooks

---

authToken?

optional authToken: string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16095

Authorization token for additional security

When set, the handler will verify the Authorization header matches this token. Use for simple auth in trusted environments.