Webhooks

Setup
From the Account Panel in Amboss.Space under the Notifications, enter the URL that the webhooks should be sent to.
​
​
Example Output
To get a sense of what data will be sent to the webhook URL for each event type, here are some examples.
Validation Push
When registering the webhook URL, a test push is performed that should return a value in the 200's range.
{
  "test": "validation push"
}
Magma Order Event
This event is triggered when a Magma buyer creates an order from an existing offer.
{
  "event_type": "MAGMA",
  "payload": {
    "order_id": "8db5d9d3-ec85-4060-b73c-5950df4a4317"
  }
}
Open Channel Event
This event is triggered when a channel is opened to a node that is being monitored.
{
  "event_type": "OPENCHANNEL",
  "payload": {
    "edge": {
      "chan_id": "739603x2169x0",
      "node1_pub": "038fe1bd966b5cb0545963490c631eaa1924e2c4c0ea4e7dcb5d4582a1e7f2f1a5",
      "node2_pub": "03a87ef6c14b9965007c97b61a1d2906b02d493c7e37259c9a23bae3f860f3a96f",
      "transaction_id": "48d60dbc94baf51f09272f8d3d47e7b351ca244081a5b4634d46a5297d8f0230",
      "transaction_vout": 0,
      "capacity": "10000000",
      "node1_alias": "zero fee routing | CLN",
      "node2_alias": "RevolucionBitcoin"
    }
  }
}
Close Channel Event
This event is triggered when a channel is closed to a node that is being monitored.
{
  "event_type": "CLOSECHANNEL",
  "payload": {
    "edge": {
      "chan_id": "738456x1669x0",
      "node1_pub": "021434418bd3a981f4553cad7a911c6f42a9ef2816110543d989af7fead917314a",
      "node2_pub": "038fe1bd966b5cb0545963490c631eaa1924e2c4c0ea4e7dcb5d4582a1e7f2f1a5",
      "transaction_id": "245c2f8c323a545b2b1c021073de53eee3884165bdb748806141c3c99c1c99a3",
      "transaction_vout": 0,
      "capacity": "10000000",
      "policies": [
        {
          "public_key": "038fe1bd966b5cb0545963490c631eaa1924e2c4c0ea4e7dcb5d4582a1e7f2f1a5",
          "time_lock_delta": 34,
          "min_htlc": "1",
          "fee_base_msat": "0",
          "fee_rate_milli_msat": "0",
          "disabled": false,
          "max_htlc_msat": "1000"
        },
        {
          "public_key": "021434418bd3a981f4553cad7a911c6f42a9ef2816110543d989af7fead917314a",
          "time_lock_delta": 40,
          "min_htlc": "1000",
          "fee_base_msat": "0",
          "fee_rate_milli_msat": "0",
          "disabled": false,
          "max_htlc_msat": "10000000000"
        }
      ],
      "closed_height": 739616,
      "node1_alias": "Black Pearl 🏴\u200d☠",
      "node2_alias": "zero fee routing | CLN"
    }
  }
}
Verification
With each webhook push, amboss-webhook-secret is provided as a header which can be compared to the value shown in Amboss.Space in the webhooks section of the Account notifications section.

API - Previous

Introduction

Next - API

Magma

Last modified 1mo ago

Copy link

Outline