Skip to main content

Order Canceled Webhook

Aghanim utilizes an order canceled webhook to inform you of a transaction reversed by a bank or a payment system, providing detailed information about the event.

The order canceled webhook is activated through the Order canceled event, selectable in Game → Webhooks.

warning

To remove in-game items from player accounts, use the item.remove webhook. The order canceled webhook is designed to provide detailed data when item.remove is insufficient.

Order canceled flow imageOrder canceled flow image

Requirements​

To use order canceled webhooks from Aghanim, you should have the webhook server configured as follows:

  • HTTPS endpoint, accepting POST webhook requests.
  • Listen for events, generated and signed by Aghanim.
  • Handle the idempotency_key included in the webhook payload to prevent processing duplicate webhooks.
  • Responds with a 2xx status code upon successful handling of an order canceled event, and 4xx or 5xx for denial or errors.

Configuration​

  1. Develop a function for the order.canceled webhook processing.
  2. Make your endpoint available.
  3. Register your endpoint within Aghanim account → Game → Webhooks → New Webhook by choosing the Order canceled event.

Alternatively, you can register your endpoint within Aghanim using the Create Webhook API method.

Need help?
Contact our integration team at integration@aghanim.com