WebhookHandlerConfig
SIP Protocol API Reference v0.15.1
SIP Protocol API Reference / WebhookHandlerConfig
Interface: WebhookHandlerConfig
Section titled “Interface: WebhookHandlerConfig”Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16159
Configuration for the Helius webhook handler
Security
Section titled “Security”This config contains sensitive cryptographic keys. Never log, store in plain text, or transmit insecurely.
Properties
Section titled “Properties”viewingPrivateKey
Section titled “viewingPrivateKey”viewingPrivateKey:
`0x${string}`
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16167
Recipient’s viewing private key (hex)
Security
Section titled “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
Section titled “spendingPublicKey”spendingPublicKey:
`0x${string}`
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16169
Recipient’s spending public key (hex)
onPaymentFound
Section titled “onPaymentFound”onPaymentFound: (
payment) =>void|Promise<void>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16175
Callback when a payment is found
Parameters
Section titled “Parameters”payment
Section titled “payment”The detected payment details
Returns
Section titled “Returns”void | Promise<void>
onError?
Section titled “onError?”
optionalonError?: (error,transaction?) =>void
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16182
Optional callback for errors
Parameters
Section titled “Parameters”Error
The error that occurred
transaction?
Section titled “transaction?”The transaction that caused the error (if available)
Returns
Section titled “Returns”void
webhookSecret?
Section titled “webhookSecret?”
optionalwebhookSecret?:string
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16192
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?
Section titled “authToken?”
optionalauthToken?:string
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:16199
Authorization token for additional security
When set, the handler will verify the Authorization header matches this token. Use for simple auth in trusted environments.