Webhook Connection

Webhook URL

Upon the initiation of an incoming transaction, Nebulox will dispatch a POST request to the designated webhook URL, carrying a payload containing transaction details. Setup Procedure:

To establish your webhook connection, follow these steps:\

  1. Provide a Valid Webhook URL

  2. Whitelist Our IP Address

  3. Verify Your Invoice (Optional):

Provide a valid Webhook URL

When configuring a new Nebulox gateway, it is imperative to furnish a valid webhook URL. This ensures Nebulox can seamlessly transmit real-time notifications for new transactions, facilitating smooth integration and laying the groundwork for automated operations within your payment processing flow.

if your Webhook URL is valid, you will be posted a payload like this:

{
  "orderId": "dpkg-1234",
  "txId": "cf2efce87f85a16e4bac7d0b3cdd548700f074fa375c0640b0da02155266d200",
  "amount": "6.9",
  "confirmations": 1,
  "status": "COMPLETED"
}

Whitelist our IP address

After configuring your URL, it is essential to whitelist Nebulox's IP address. Webhooks are triggered from one or more of the following IP addresses:

1.1.1.1, 1.1.1.1, 1.1.1.1

Verify your invoice (Optional)

Optionally, you can utilize the provided API to verify incoming invoices at your specified URL. This security check is recommended as an additional step to thwart any potential malicious activity.\

Verify your invoice

POST https://api.nebulox.io/api/invoice/verify

Call this method to verify your invoice

Request Body

NameTypeDescription

apiKey*

string

Your API key

trackingCode*

number

The tracking code of the invoice

{
    "message": "Operation was successful.",
    "result": {
        "amount": "10.47657961",
        "paidAmount": "0.00000000",
        "baseCurrency": "EUR",
        "id": "f91fa492-5858-4607-91e9-7ef484e36857",
        "trackingCode": 100061,
        "orderId": "HIX-2112e",
        "price": 1,
        "description": "test",
        "itemName": "TITAB",
        "from": "instagram 1",
        "status": "EXPIRED",
        "expirationDate": "2023-12-23T11:01:40.993Z",
        "created_at": "2023-12-23T09:21:41.423Z",
        "updated_at": "2024-01-06T09:46:12.000Z",
        "gateway": null,
        "address": "TSwEBXcr6mGazCTCpoaNgrN2S2MLTMs1ZW",
        "network": {
            "name": "Tron"
        },
        "coin": {
            "name": "Tron",
            "symbol": "TRX"
        },
        "transactions": [],
        "url": "https://nebulox.io/app/user-invoice/f91fa492-5858-4607-91e9-7ef484e36857",
        "expirationRemainingTime": 0
    },
    "meta": {}
}
const axios = require('axios');

axios.post('https://api.nebulox.io/api/invoice/verify', {
    apiKey: "YOUR_API_KEY",
    trackingCode: 100030
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.error(error);
  });

Good to know: Ensure that your Webhook URL is not only correctly set up to accept incoming POST requests but also configured accurately within Nebulox's settings. This meticulous setup guarantees seamless reception of timely updates about new transactions, allowing you to stay informed and responsive to the activities related to your provided address.

Last updated