Webhooks

Webhooks for AIO

Important: Before proceeding, make sure you are familiar with subaddresses, the collection process and collection address and the Withdrawal/Refund process.

Understanding Webhooks

Webhooks are notifications sent automatically to your system (like an e-commerce website) to inform you about transactions like deposits and withdrawals.

Types of Webhooks

Deposit Webhook

How it Works:

When a customer sends funds to their subaddress for a purchase, AIO collects these funds into the collection address.

This address aggregates funds from all subaddresses under your AIO account.

Once collected, AIO notifies your system of the successful transaction via a webhook.

Details Included: The webhook includes transaction details like from address, to address, transaction hash, and timestamps.

Withdrawal Webhook

How it Works:

If a customer requests a refund or needs to withdraw, they initiate this through your system.

Your system then requests AIO to process the withdrawal using the customer's wallet details.

AIO completes the withdrawal and informs your system through a webhook.

Details Included: Similar to deposits, the webhook contains comprehensive transaction details.

Setting Up Webhooks

Adding a Webhook URL:

Navigate to Web Hook in the settings dropdown menu.

Click on "Edit" next to the "Sub address" row to add your webhook URL for deposits.

Paste your webhook URL and click "Confirm". Upon confirm, URL is tested for 200 response. If it is 200 then URL is updated otherwise not.

Testing Your Webhook:

AIO sends a test request to your system. If the message "This is a test request" is received, respond with a 200 status code to confirm the URL is valid. Any other response will mean the URL won’t be added.

Sending Custom Requests Through AIO Dashboard

Click the "Test" button next to your webhook URL in the Hook URL column. This opens a popup.

Optionally update the webhook URL if adding a new one.

Edit key values as needed.

Click "Test".

If the test is successful and the URL is new, click the "Update URL" button to save changes.

Next Steps

Up next: Learn how to configure a Telegram bot for AIO notifications.

Webhooks for AIO#

Understanding Webhooks#

Types of Webhooks#

Setting Up Webhooks#