Skip to main content

Order Paid Webhook

Aghanim's order paid webhook notifies your game of successfully completed payments on the game hub, providing detailed information about the transaction.

This webhook is activated through the Order paid event, selectable in Game → Webhooks.

warning

To credit in-game items to player accounts, use the item.add webhook. The order paid webhook is designed to provide detailed data when item.add is insufficient.

Payment flow imagePayment flow image

Requirements​

To use order paid 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.
  • Respond with 2xx status codes if a purchased item was credited successfully, and 4xx or 5xx for denial or errors.

Configuration​

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

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

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