Coupon Redeemed Webhook

Aghanim offers a coupon redeemed webhook to notify your game when a redeem code for a free item has been used by a player, providing detailed information about the event.

This webhook is activated through the Coupon redeemed event, selectable in Game → Webhooks.

warning

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

Requirements

To use the redeemed coupon webhook 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.
Respond with 2xx status codes to signal successful processing, and 4xx or 5xx for denial or errors.

Configuration

Develop a function for the coupon.redeemed webhook processing.
Make your endpoint available.
Register your endpoint within Aghanim account → Game → Webhooks → New Webhook by choosing the corresponding event type.

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

Request schema

Below is an example of an coupon.redeemed webhook request:

HTTP
cURL

POST /your/webhook/uri HTTP/1.1
Content-Type: application/json
Host: your-webhook-endpoint.com
User-Agent: Aghanim/0.1.0
X-Aghanim-Signature: 2e45ed4dede5e09506717490655d2f78e96d4261040ef48cc623a780bda38812
X-Aghanim-Signature-Timestamp: 1725548450

{
  "event_type": "coupon.redeemed",
  "event_data": {
    "player_id": "2D2R-OP3C",
    "coupon": {
      "code": "WELCOME",
      "sku": "crystals",
      "redeemed_at": 1725548450
    },
    "item": {
      "id": "itm_exTBZQmIlDz",
      "name": "Crystals",
      "description": "Reign supreme over your rivals with this massive crystal treasure.",
      "sku": "crystals",
      "quantity": 480000,
      "price": 9499,
      "price_decimal": 94.99,
      "currency": "USD",
      "type": "item",
      "nested_items": null
    }
  },
  "event_time": 1725548450,
  "event_id": "whevt_eCacGbJVbvToOgzjXUgOCitkQE",
  "idempotency_key": "idmpt_aXRlb...JkX2VFS",
  "request_id": "d1593e9c-c291-4004-8846-6679c2e5810b",
  "sandbox": false,
  "trigger": "hub.redeem",
  "transaction_id": "whtx_eCacGbJVbvT",
  "context": null,
  "game_id": "gm_exTAyxPsVwh"
}
            

curl "https://your-webhook-endpoint.com/your/webhook/uri" \
    -X POST \
    -H "Content-Type: application/json" \
    -H "User-Agent: Aghanim/0.1.0" \
    -H "X-Aghanim-Signature: 2e45ed4dede5e09506717490655d2f78e96d4261040ef48cc623a780bda38812" \
    -H "X-Aghanim-Signature-Timestamp: 1725548450" \
    -d '{
      "event_type": "coupon.redeemed",
      "event_data": {
        "player_id": "2D2R-OP3C",
        "coupon": {
          "code": "WELCOME",
          "sku": "crystals",
          "redeemed_at": 1725548450
        },
        "item": {
          "id": "itm_exTBZQmIlDz",
          "name": "Crystals",
          "description": "Reign supreme over your rivals with this massive crystal treasure.",
          "sku": "crystals",
          "quantity": 480000,
          "price": 9499,
          "price_decimal": 94.99,
          "currency": "USD",
          "type": "item",
          "nested_items": null
        }
      },
      "event_time": 1725548450,
      "event_id": "whevt_eCacGbJVbvToOgzjXUgOCitkQE",
      "idempotency_key": "idmpt_aXRlb...JkX2VFS",
      "request_id": "d1593e9c-c291-4004-8846-6679c2e5810b",
      "sandbox": false,
      "trigger": "hub.redeem",
      "transaction_id": "whtx_eCacGbJVbvT",
      "context": null,
      "game_id": "gm_exTAyxPsVwh"
    }'
            

The Event schema

Key	Type	Description
`event_id`	`string`	Unique Event ID generated by Aghanim.
`game_id`	`string`	Your game ID in the Aghanim system.
`event_type`	`string`	The type of the event, `coupon.redeemed` in this case.
`event_time`	`number`	Event date in Unix epoch time.
`event_data`	`EventData`	Contains the event-specific data, with possible keys for inherited objects.
`idempotency_key`	`string`	Ensures webhook actions are executed only once, even if retried.
`request_id`	`string\|null`	If the event was triggered by an API request, the request ID is included.
`sandbox`	`boolean`	Indicates whether the event was sent from the sandbox game environment.
`trigger`	`string\|null`	The trigger that caused the event to be sent.
`transaction_id`	`string`	The transaction ID generated by Aghanim. This ID may be the same for multiple events emitted within the same transaction.
`context`	`EventContext\|null`	Contextual information about the event.

The EventContext schema

Key	Type	Description
`order`	`OrderContext\|null`	Order information associated with the event if applicable.
`player`	`PlayerContext\|null`	(Optional) Player information. To add this, enable "Add player context" in the webhook settings.

The EventData schema

Key	Type	Description
`player_id`	`string`	The unique Player ID chosen for player authentication.
`coupon`	`Coupon`	The coupon object containing the redeem code data.
`item`	`Item`	The item object containing details about the free item provided upon redeeming the code.

The Coupon object

Key	Type	Description
`code`	`string`	Redeem code.
`sku`	`string`	Free item SKU provided upon the redeem code usage.
`redeemed_at`	`number`	Code usage date in Unix epoch time.

The Trigger values

Value	Description
`hub.redeem`	When a coupon for a free item is redeemed.
`test`	When using the "Send test event" in the Dashboard.

The Item schema

Key	Type	Description
`id`	`string`	Item ID generated by Aghanim.
`name`	`string`	Item name.
`description`	`string\|null`	Item description.
`sku`	`string`	Item SKU matching on both the game and Aghanim sides.
`quantity`	`number`	Item quantity.
`type`	`string`	The type of item. Possible values: `item`, `bundle`.
`nested_items`	`NestedItem[]\|null`	An array of items included in the bundle.
`fallback_item`	`Item\|null`	The item that may be given as fallback if the main item can't be given to the player.

Item type bundle can contain several nested items inside.
You can handle the common sku of the bundle or handle each nested item individually.

The NestedItem schema

Key	Type	Description
`id`	`string`	Item ID generated by Aghanim.
`name`	`string`	Item name.
`description`	`string\|null`	Item description.
`sku`	`string`	Item SKU matching on both the game and Aghanim sides.
`quantity`	`number`	Item quantity.
`type`	`string`	The type of item. Possible values: `item`, `bundle`.
`nested_items`	`NestedItem[]\|null`	An array of items included in the bundle.

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