Skip to main content
WEBHOOK
gift_card.order.purchased
{
  "event": "gift_card.order.purchased",
  "payload": {
    "id": 123,
    "gift_card_id": 123,
    "gift_card_offer_id": 123,
    "region_id": 123,
    "brand_id": 123,
    "buyer": {
      "id": 123,
      "username": "<string>"
    },
    "title": "<string>",
    "face_value_amount": "<string>",
    "face_value_unit": "<string>",
    "quantity": 123,
    "unit_price_eur": "<string>",
    "unit_price_usd": "<string>",
    "price_eur": "<string>",
    "price_usd": "<string>",
    "status": "pending",
    "keys": [
      {
        "id": 123,
        "gift_card_order_id": 123,
        "key": "<string>",
        "type": {
          "value": "text",
          "name": "<string>"
        },
        "created_at": 123,
        "revealed_at": 123
      }
    ],
    "created_at": 123,
    "updated_at": 123,
    "completed_at": 123,
    "refunded_at": 123
  }
}
{
  "status": "success"
}
Learn more about how GameBoost handles webhooks.

Headers

Signature
string
required

HMAC-SHA256 signature of the request body using your webhook secret. Verify this to ensure the webhook is from GameBoost.

Example:

"417142a6b1c6e..."

User-Agent
string
required

The user agent of the request. Must be "GameBoost Server".

Example:

"GameBoost Server"

Body

application/json

Webhook payload for gift card order purchased event

event
enum<string>
required

Event type identifier

Available options:
gift_card.order.purchased
payload
object
required

Gift card order object

Response

Webhook received successfully. Return 200 to acknowledge receipt.

status
string
Example:

"success"