New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Webhooks documentation. #108

Merged

roeierez merged 13 commits into main from webhooks

Dec 17, 2023

Member

roeierez commented Dec 5, 2023

No description provided.


          Webhooks documentation.

48fa752

ok300 mentioned this pull request

Roadmap to payment notifications feature breez/breez-sdk-greenlight#574

Closed

16 tasks

Member Author

roeierez commented Dec 6, 2023

opening for early review.

roeierez requested review from erdemyerebasmaz and dangeross

December 6, 2023 13:23

roeierez marked this pull request as ready for review

December 6, 2023 13:25

dangeross reviewed

View reviewed changes

Contributor

dangeross left a comment

Reads well, easy to understand

src/SUMMARY.md Outdated

@@ @@ -21,4 +21,5 @@ @@
               - [Buy Bitcoin](guide/buy_btc.md)
               - [Static Channel Backup](guide/static_channel_backup.md)
               - [Service Status](guide/service_status.md)
+              - [Payment Notificaions](guide/payment_notification.md)

Contributor

dangeross Dec 6, 2023

Suggested change

      
            - [Payment Notificaions](guide/payment_notification.md)
          
            - [Payment Notifications](guide/payment_notification.md)

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              </section>
+              ## Processing the Payload
+              Processing the Payload is according to the application needs. One of the major use cases that can be handled via webhooks is receiving a payment in mobile app while the app is not running, or in short "offline receive"

Contributor

dangeross Dec 6, 2023

Suggested change

      
            Processing the Payload is according to the application needs. One of the major use cases that can be handled via webhooks is receiving a payment in mobile app while the app is not running, or in short "offline receive"
          
            Processing of the Payload can be done according to the application's needs. One of the major use cases that can be handled via webhooks is receiving a payment in a mobile app while the app is not running, or in short "offline receive"

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              Processing the Payload is according to the application needs. One of the major use cases that can be handled via webhooks is receiving a payment in mobile app while the app is not running, or in short "offline receive"
+              ## Webhook integration for "offline recieve"
+              In the context of mobile applications using the Breez SDK for Lightning Network payments, a crucial architectural component involves the seamless flow of payment notifications to the user's mobile device. This process is facilitated through a Notification Delivery Service (NDS), acting as an intermediary. When a payment is made to a user, the LSP sends a notification to the NDS, configured with a specific webhook URL. The NDS then processes this information and dispatches a push notification to the intended mobile device, ensuring the user receives timely updates about incoming payments. This architecture necessitates vendors to set up and maintain their own NDS, tailored to handle and forward these notifications efficiently.

Contributor

dangeross Dec 6, 2023

Suggested change

      
            In the context of mobile applications using the Breez SDK for Lightning Network payments, a crucial architectural component involves the seamless flow of payment notifications to the user's mobile device. This process is facilitated through a Notification Delivery Service (NDS), acting as an intermediary. When a payment is made to a user, the LSP sends a notification to the NDS, configured with a specific webhook URL. The NDS then processes this information and dispatches a push notification to the intended mobile device, ensuring the user receives timely updates about incoming payments. This architecture necessitates vendors to set up and maintain their own NDS, tailored to handle and forward these notifications efficiently.
          
            In the context of mobile applications using the Breez SDK for Lightning Network payments, a crucial architectural component involves the seamless flow of payment notifications to the user's mobile device. This process is facilitated through a Notification Delivery Service (NDS) acting as an intermediary. When a payment is made to a user, the LSP sends a notification to the NDS configured with a specific webhook URL. The NDS then processes this information and dispatches a push notification to the intended mobile device, ensuring the user receives timely updates about incoming payments. This architecture necessitates vendors setting up and maintaining their own NDS, tailored to handle and forward these notifications efficiently.

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              In the context of mobile applications using the Breez SDK for Lightning Network payments, a crucial architectural component involves the seamless flow of payment notifications to the user's mobile device. This process is facilitated through a Notification Delivery Service (NDS), acting as an intermediary. When a payment is made to a user, the LSP sends a notification to the NDS, configured with a specific webhook URL. The NDS then processes this information and dispatches a push notification to the intended mobile device, ensuring the user receives timely updates about incoming payments. This architecture necessitates vendors to set up and maintain their own NDS, tailored to handle and forward these notifications efficiently.
+              ## Step 1: Run your own NDS
+              As written above you will need to run your own NDS because NDS is configured to send push notifications to your app users, therefore configured with the required keys and certificates.

Contributor

dangeross Dec 6, 2023

Suggested change

      
            As written above you will need to run your own NDS because NDS is configured to send push notifications to your app users, therefore configured with the required keys and certificates.
          
            As written above you will need to run your own NDS because the NDS is configured to send push notifications to your app users, therefore configured with the required keys and certificates.

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              ## Step 1: Run your own NDS
+              As written above you will need to run your own NDS because NDS is configured to send push notifications to your app users, therefore configured with the required keys and certificates.
+              If you don't want to write it from scratch you can use our running <a href="https://github.com/breez/notify">NDS</a>

Contributor

dangeross Dec 6, 2023

Suggested change

      
            If you don't want to write it from scratch you can use our running <a href="https://github.com/breez/notify">NDS</a>
          
            If you don't want to write it from scratch, you can use our own <a href="https://github.com/breez/notify">NDS</a> implementation.

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              As written above you will need to run your own NDS because NDS is configured to send push notifications to your app users, therefore configured with the required keys and certificates.
+              If you don't want to write it from scratch you can use our running <a href="https://github.com/breez/notify">NDS</a>
+              Our used NDS expects urls in the following format:

Contributor

dangeross Dec 6, 2023

Suggested change

      
            Our used NDS expects urls in the following format:
          
            Our NDS implementation expects URLs in the following format:

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              Our used NDS expects urls in the following format:
+              <section><i>https://your-nds-service.com/notify?platform=<ios|android>&token=[PUSH_TOKEN]</i></section>
+              Once the NDS received such request it will send a push notification to the matched device.

Contributor

dangeross Dec 6, 2023

Suggested change

      
            Once the NDS received such request it will send a push notification to the matched device.
          
            Once the NDS has received such request it will send a push notification to the matched device.

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated


		* Handle the Notification: After confirming the payment, handle the notification accordingly by updating the app's UI.

		As a reference implelentation see how we did it in c-breez wallet: <a href="https://github.com/breez/c-breez/blob/main/ios/Breez%20Notification%20Service%20Extension/NotificationService.swift">NotificationService.swift</a>

Contributor

dangeross Dec 6, 2023

Suggested change

      
            As a reference implelentation see how we did it in c-breez wallet: <a href="https://github.com/breez/c-breez/blob/main/ios/Breez%20Notification%20Service%20Extension/NotificationService.swift">NotificationService.swift</a>
          
            As a reference implementation, see how we did it in c-breez wallet: <a href="https://github.com/breez/c-breez/blob/main/ios/Breez%20Notification%20Service%20Extension/NotificationService.swift">NotificationService.swift</a>

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              The Breez SDK provides a robust feature for applications to receive real-time notifications for incoming payments over the Lightning Network. This is achieved through the use of webhooks. A webhook is a powerful tool that allows your application to be notified via a specified URL when a payment is received.
+              ## Setting Up the Webhook
+              To utilize this feature, you need to set up a webhook that Breez can call when a payment is received.

Contributor

dangeross Dec 6, 2023

Suggested change

      
            To utilize this feature, you need to set up a webhook that Breez can call when a payment is received.
          
            To utilize this feature, you need to set up a webhook that the LSP can call when a payment is received.

Member Author

roeierez Dec 9, 2023

Done

src/guide/payment_notification.md Outdated

+              </custom-tabs>
+              ## Handling Incoming Notifications
+              When a payment is received, Breez will send a POST request to your webhook URL. The request body will contain details about the payment.

Contributor

dangeross Dec 6, 2023

Suggested change

      
            When a payment is received, Breez will send a POST request to your webhook URL. The request body will contain details about the payment.
          
            When a payment is received, the LSP will send a POST request to your webhook URL. The request body will contain details about the payment.

Member Author

roeierez Dec 9, 2023

Done

JssDWt reviewed

View reviewed changes

Contributor

JssDWt left a comment

It looks good and seems clear.
Some points in the comments below.

src/guide/payment_notification.md Outdated Show resolved Hide resolved

src/guide/payment_notification.md Outdated Show resolved Hide resolved

src/guide/payment_notification.md Outdated Show resolved Hide resolved

src/guide/payment_notification.md Outdated


		* Wake Up the App: When a push notification is received, the NotificationServiceExtension will be triggered, waking up the app.

		* Connect with Breez SDK: Inside the extension, implement the logic to establish a connection with the Breez SDK which also runs the signer so the payment can be processed.

Contributor

JssDWt Dec 7, 2023

Note: This is the first mention of the signer in the documentation. We should introduce this entire concept of having to be online in order to receive a payment in the documentation elsewhere.

Member Author

roeierez Dec 9, 2023

I used different wording for now

roeierez added 3 commits

December 9, 2023 08:16


          fix spelling and feedback

9a0b380


          some more feedback

648322c


          fix spelling

31483fb

roeierez requested review from dangeross and JssDWt

December 9, 2023 06:22

dangeross approved these changes

View reviewed changes

Contributor

dangeross left a comment

Looks good! Just needs the other languages.

snippets/rust/src/webhook.rs Outdated

+              use std::sync::Arc;
+              use anyhow::Result;
+              use breez_sdk_core::InputType::LnUrlWithdraw;

Contributor

dangeross Dec 9, 2023

This line is not needed. Maybe add webhook to main.rs so the CI picks it up.

ubbabeck approved these changes

View reviewed changes

Contributor

ubbabeck left a comment

looks clear and concise.

roeierez added 9 commits

December 14, 2023 09:46


          Add snippets

05f18fe


          fix snippets

28b5e68


          fix swift snippet

5f541d4


          fix snippets

86063be


          fix swift snippet

95be805


          remove redundant line from rust snippet

196d7ec


          add webhook module

16c4d36


          fix rust code

c5b43c1


          fix rust

2c2f173

roeierez merged commit 4215047 into main

59 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet