Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
dangeross committed Oct 22, 2024
1 parent ce726fc commit fa32494
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions src/guide/payment_notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ By default the Notification Plugin should receive the push notification data in
{
"notification_type": "payment_received",
"notification_payload": "{ \"payment_hash\": \"\" }",
"app_data": ""
"app_data": "..."
}
```
The structure and fields of this data can be changed by [customising the push messages](/notifications/custom_messages.md) handling in the Notification Plugin to reflect how your NDS sends this data over push notifications.
Expand All @@ -36,7 +36,7 @@ The `payment_received` notification type will be received by the webhook in the
{
"template": "payment_received",
"data": {
"payment_hash": "" // The payment hash that is in progress
"payment_hash": "..." // The payment hash that is in progress
}
}
```
Expand All @@ -50,7 +50,7 @@ The `address_txs_confirmed` notification type will be received by the webhook in
{
"template": "address_txs_confirmed",
"data": {
"address": "" // The address of the swap with confirmed funds
"address": "..." // The address of the swap with confirmed funds
}
}
```
Expand All @@ -66,8 +66,8 @@ The `lnurlpay_info` notification type will be received by the webhook in the fol
{
"template": "lnurlpay_info",
"data": {
"callback_url": "", // The URL of the LNURL service
"reply_url": "" // The URL to reply to this request
"callback_url": "...", // The URL of the LNURL service
"reply_url": "..." // The URL to reply to this request
}
}
```
Expand All @@ -79,7 +79,7 @@ The `lnurlpay_invoice` notification type will be received by the webhook in the
"template": "lnurlpay_invoice",
"data": {
"amount": 0, // The amount in millisatoshis within the min/max sendable range
"reply_url": "" // The URL to reply to this request
"reply_url": "..." // The URL to reply to this request
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion src/notifications/custom_messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The Notification Plugin by default handles a specific format of push notificatio
{
"notification_type": "payment_received",
"notification_payload": "{ \"payment_hash\": \"\" }",
"app_data": ""
"app_data": "..."
}
```

Expand Down
12 changes: 6 additions & 6 deletions src/notifications/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ By default the Notification Plugin should receive the push notification data in
{
"notification_type": "payment_received",
"notification_payload": "{ \"payment_hash\": \"\" }",
"app_data": ""
"app_data": "..."
}
```
The structure and fields of this data can be changed by [customising the push messages](custom_messages.md) handling in the Notification Plugin to reflect how your NDS sends this data over push notifications.
Expand All @@ -36,7 +36,7 @@ The `payment_received` notification type will be received by the webhook in the
{
"template": "payment_received",
"data": {
"payment_hash": "" // The payment hash that is in progress
"payment_hash": "..." // The payment hash that is in progress
}
}
```
Expand All @@ -50,7 +50,7 @@ The `address_txs_confirmed` notification type will be received by the webhook in
{
"template": "address_txs_confirmed",
"data": {
"address": "" // The address of the swap with confirmed funds
"address": "..." // The address of the swap with confirmed funds
}
}
```
Expand All @@ -66,8 +66,8 @@ The `lnurlpay_info` notification type will be received by the webhook in the fol
{
"template": "lnurlpay_info",
"data": {
"callback_url": "", // The URL of the LNURL service
"reply_url": "" // The URL to reply to this request
"callback_url": "...", // The URL of the LNURL service
"reply_url": "..." // The URL to reply to this request
}
}
```
Expand All @@ -79,7 +79,7 @@ The `lnurlpay_invoice` notification type will be received by the webhook in the
"template": "lnurlpay_invoice",
"data": {
"amount": 0, // The amount in millisatoshis within the min/max sendable range
"reply_url": "" // The URL to reply to this request
"reply_url": "..." // The URL to reply to this request
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion src/notifications/setup_nds.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Receiving push notifications involves using an Notification Delivery Service (ND
{
"template": "payment_received",
"data": {
"payment_hash": "" // The payment hash that is in progress
"payment_hash": "..." // The payment hash that is in progress
}
}
```
Expand Down

0 comments on commit fa32494

Please sign in to comment.