https://github.com/jimasuen/lnbits-webhook-example
Webhook handler example code for LNbits in PHP
https://github.com/jimasuen/lnbits-webhook-example
lnbits webhook
Last synced: 3 months ago
JSON representation
Webhook handler example code for LNbits in PHP
- Host: GitHub
- URL: https://github.com/jimasuen/lnbits-webhook-example
- Owner: jimasuen
- Created: 2024-01-19T18:47:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T18:27:08.000Z (over 2 years ago)
- Last Synced: 2026-03-28T00:42:35.850Z (3 months ago)
- Topics: lnbits, webhook
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Webhook handler example code for LNbits in PHP
Various endpoints in the LNbits API support using webhooks in form of adding a webhook URL in the webhook field. This is an example of using PHP and the create or pay invoice endpoint in the LNbits API (https://legend.lnbits.com/docs#/default/api_payments_create_api_v1_payments_post).
Example of adding the webhook URL using cURL (this could be done on the dashboard as well):
curl -X 'POST'
https://your-lnbits-endpoint.com/api/v1/payments
-H "X-Api-Key: "
-H "Content-type: application/json"
-d '{"out": false, "amount": 1, "memo": "test webhook", "webhook": "https://example.com/webhook.php"}'
The value of the webhook field refers to where you have the code that will process the data from the webhook. This example assumes that the code processing the data is found in https://example.com/webhook.php
Example code in webhook.php to process the webhook data:
checking_id;
/**
** From here, you write your code to process the data the way you want.
**
**
**/
}
}
?>
Note:
If you use https://webhook.site/ in your initial tests, you can skip the step on logging the content to a file.
# Webhook data and paying external invoices using the LNbits API
When using the LNbits pay invoice API to pay an external invoice, the webhook field defaults to `null` despite adding a webhook URL. If you need to send webhook data after paying an external invoice, an approach that can be followed is to use the resulting `payment_hash` that is outputed to check an invoice and send the JSON output to the webhook URL:
Checking the status of the bolt11 invoice:
```
curl -X 'GET'
https://your-lnbits-endpoint.com/api/v1/payments/
-H "X-Api-Key: "
-H "Content-type: application/json"
```
Example of sending resulting JSON data to webhook URL:
```
curl -X 'POST'
https://example.com/webhook.php
-H "Content-type: application/json"
-d '{
}'
```
# References
1. https://stackoverflow.com/questions/47565321/how-to-get-webhook-response-data