Merge pull request #108 from breez/webhooks

Webhooks documentation.
This commit is contained in:
Roei Erez
2023-12-17 14:42:44 +02:00
committed by GitHub
12 changed files with 394 additions and 2 deletions

View File

@@ -1,6 +1,6 @@
using Breez.Sdk;
public class ServiceStatusSnippets
public class WebhooksSnippets
{
public void HealthCheckStatus(BlockingBreezServices sdk)
{
@@ -8,7 +8,7 @@ public class ServiceStatusSnippets
try
{
var healthCheck = sdk.ServiceHealthCheck();
Console.WriteLine($"Current service status is: {healthCheck.status}");
Console.WriteLine($"Current service status is: {healthCheck.status}");
}
catch (Exception)
{

View File

@@ -0,0 +1,32 @@
using Breez.Sdk;
public class ServiceStatusSnippets
{
public void Webhook(BlockingBreezServices sdk)
{
// ANCHOR: register-webook
try
{
sdk.RegisterWebhook("https://yourapplication.com");
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: register-webook
}
public void PaymentWebhook(BlockingBreezServices sdk)
{
// ANCHOR: register-payment-webook
try
{
sdk.RegisterWebhook("https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>");
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: register-payment-webook
}
}

View File

@@ -0,0 +1,13 @@
import 'package:breez_sdk/breez_sdk.dart';
Future<void> webhook() async {
// ANCHOR: register-webook
await BreezSDK().registerWebhook(webhookUrl: "https://yourapplication.com");
// ANCHOR_END: register-webook
}
Future<void> paymentWebhook({required String paymentHash}) async {
// ANCHOR: register-payment-webook
await BreezSDK().registerWebhook(webhookUrl: "https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>");
// ANCHOR_END: register-payment-webook
}

21
snippets/go/webhook.go Normal file
View File

@@ -0,0 +1,21 @@
package example
import (
"log"
)
func Webhook() {
// ANCHOR: register-webook
if err := sdk.RegisterWebhook("https://yourapplication.com"); err != nil {
log.Printf("Webhook registration failed: %v", err)
}
// ANCHOR_END: register-webook
}
func PaymentWebhook() {
// ANCHOR: register-payment-webook
if err := sdk.RegisterWebhook("https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>"); err != nil {
log.Printf("Webhook registration failed: %v", err)
}
// ANCHOR_END: register-payment-webook
}

View File

@@ -0,0 +1,24 @@
package com.example.kotlinmpplib
import breez_sdk.*
class Webhooks {
fun Webhook(sdk: BlockingBreezServices) {
// ANCHOR: register-webook
try {
sdk.registerWebhook("https://yourapplication.com")
} catch (e: Exception) {
// Handle error
}
// ANCHOR_END: register-webook
}
fun paymentWebhook(sdk: BlockingBreezServices) {
// ANCHOR: register-payment-webook
try {
sdk.registerWebhook("https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>")
} catch (e: Exception) {
// Handle error
}
// ANCHOR_END: register-payment-webook
}
}

View File

@@ -0,0 +1,19 @@
import breez_sdk
def webhook(sdk_services):
try:
# ANCHOR: register-webook
sdk_services.registerWebhook("https://yourapplication.com")
# ANCHOR_END: register-webook
except Exception as error:
print(error)
raise
def paymentWebhook(sdk_services):
try:
# ANCHOR: register-payment-webook
sdk_services.registerWebhook("https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>")
# ANCHOR_END: register-payment-webook
except Exception as error:
print(error)
raise

View File

@@ -0,0 +1,13 @@
import { registerWebhook } from '@breeztech/react-native-breez-sdk'
const webhook = async () => {
// ANCHOR: register-webook
await registerWebhook('https://yourapplication.com')
// ANCHOR_END: register-webook
}
const paymentWebhook = async () => {
// ANCHOR: register-payment-webook
await registerWebhook('https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>')
// ANCHOR_END: register-payment-webook
}

View File

@@ -14,6 +14,7 @@ mod send_payment;
mod send_spontaneous_payment;
mod service_status;
mod static_channel_backup;
mod webhook;
use anyhow::Result;
use breez_sdk_core::*;

View File

@@ -0,0 +1,19 @@
use std::sync::Arc;
use anyhow::Result;
use breez_sdk_core::*;
async fn webhook(sdk: Arc<BreezServices>) -> Result<()> {
// ANCHOR: register-webook
sdk.register_webhook("https://yourapplication.com".to_string()).await?;
// ANCHOR_END: register-webook
Ok(())
}
async fn payment_webhook(sdk: Arc<BreezServices>) -> Result<()> {
// ANCHOR: register-payment-webook
sdk.register_webhook("https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>".to_string()).await?;
// ANCHOR_END: register-payment-webook
Ok(())
}

View File

@@ -0,0 +1,20 @@
//
// ServiceStatus.swift
//
//
//
import Foundation
import BreezSDK
func webhook(sdk: BlockingBreezServices) throws {
// ANCHOR: register-webook
try sdk.registerWebhook(webhookUrl: "https://yourapplication.com")
// ANCHOR_END: register-webook
}
func paymentWebhook(sdk: BlockingBreezServices) throws {
// ANCHOR: register-payment-webook
try sdk.registerWebhook(webhookUrl: "https://your-nds-service.com/notify?platform=ios&token=<PUSH_TOKEN>")
// ANCHOR_END: register-payment-webook
}