/registerWebhook

Register a webhook with specified filters. To prepare for registering a webhook, you need to note the URL of the server you want the GK8 system to send webhook notifications to.

To secure the webhook communication, make sure to use an https address for the webhook URL. For extra security, have a random value prepared as a key and add it to the URL as follows: https://<listener_url>/random_secret_token=sadkfnherwklfnvkwlrhnjfklewjflkewjnknwklonewklfnewkonlkewnkwe

Webhooks function by a combination of filters and alert events.

Filters

• CoinSymbol: What currency are we checking for activity?
• Machine: Are we checking the "Hot" (MPC) or "Cold" (ColdVault)?
• AccountId: Which account are we checking for activity?
• MinAmount: For Input transactions, what is the smallest transaction you want to receive notifications for?
• AlertEvent: Which statuses should trigger an alert (see below for definition of options)?
• Confirmations: After how many on-chain confirmations do you want to be alerted? You can set up to ten distinct confirmation alerts for a given webhook.
• Threshold: What balance amount do we want to be notified of? This works with the "Above" and "Below" alert events to send a notification whenever the main wallet's balance crosses the threshold in the indicated direction.

AlertEvents

• No funds available: A transaction was requested, but could not be created due to inadequate funds.
• Created: A new transaction request was created.
• Failed-Limits: A transaction request was attempted, but could not be created because it exceeds the user's limits.
• Failed-Technical: A transaction request was attempted, but could not be created due to a technical issue.
• Sent: A transaction was sent to the blockchain for confirmation.
• Timeout occurred: A transaction request was automatically canceled after waiting to long for approval.
• Waiting to be processed: The transaction request is waiting for approval.
• Canceled: A user canceled the transaction.
• Waiting for external co-signer: The transaction has been approved, but the cosigners have not worked their cryptographic magic.
• Failed-Policy: A transaction request was attempted, but could not be created because it violated account policy.
• Below: In conjunction with the "threshold" filter, sends an alert whenever the main wallet balance falls below the threshold value.
• Above: In conjunction with the "threshold" filter, sends an alert whenever the main wallet balance rises above the threshold value.

Return: JSON object containing result of the webhook request and webhook ID.

-------------------- Request --------------------

      registerWebhook(
              "webhook_url"="https://192.168.1.22:8027",
              "type"=0,
              filter={"CoinSymbol": "BTC",
                      "AccountIds": ["1"],
                      "Confirmations":["1","15"],
                      "Machine": "Hot",
                      "MinAmount":"10000"
                      },
    transaction_format_version= TransactionFormatVersion.V2
          )

-------------------- Response --------------------

{
    "FunctionData": {
        "status": "Success",
        "webhookId": "wh_8...1234"
        },
    "Meta": {
        "AccessToken": "6276...79fe",
        "Destination": "0453...9d56",
        "Source": "fc581...42f3",
        "Time": "2025-02-10 13:05:23.729"
    }
}