Webhooks

Webhooks & Events

Webhooks can be setup in the LNPay.co dashboard.

Events

Event Name

Event Display Name

Note

wallet_created

Wallet Create

wallet_send

Wallet Send

wallet_receive

Wallet Receive

wallet_transfer_in

Wallet Transfer IN

wallet_transfer_out

Wallet Transfer Out

Every payload will follow the same format. an Event ID is provided to identify the event, along with an object of the type details. The data section will always contain an array of relevant objects to the event. The key of each object in the data object will match the object id: "wal":".." matches wal_czDztN5eJ4r5sJ for now this seems the easiest way to plan for future changes and additions.

Pay careful attention to passThru value. This is where context data that you have set previously, will be available throughout the journey of the wallet transaction.

NOTE: there are some server parameters that are passed through in this field as well, so it is a good idea to prefix your variables with something e.g. xyz_ticketId

Another way to send passThru data:

https://paywall.link/to/03ccb?utm_source=telegram&myUrlParameter=specialVar

Special Headers

Header

Sample Format

Description

X-LNPay-Event

wallet_send

an event from above

X-LNPay-HookId

iwhr_TBYsAgdgeOkhfA1cb5a33szZ

a unique ID for this webhook request

X-LNPay-Signature

aa46ae5d2d8367aef6693063e09...

hmac_sha256 signature of payload, if you provide a secret

User-Agent

LNPay-HookBot

standard user agent

Last updated