This is an example of a payload that will be received whenever a gift card is updated, voided, gifted, or a reminder is sent.
{
"RequestId": "b7c1a2f4-1e6d-4a2b-9c3d-5e7f8a9b0c1d",
"GiftCardId": "65f4e2c1a9b7c3d1e5f6a8b9",
"Code": "WRAP-XY7Q-4KLM",
"CreatedAt": "2023-09-25T05:18:46.590Z",
"FormattedInitialValue": "$50.00",
"InitialValue": 50.0,
"Balance": 42.5,
"FormattedBalance": "$42.50",
"Currency": "USD",
"TotalIssuedAmount": 50.0,
"FormattedTotalIssuedAmount": "$50.00",
"ExpiresAtUtc": "2024-09-25T05:18:46.590Z",
"RecipientName": "Jane Doe",
"RecipientEmailAddress": "[email protected]",
"AppleWalletUrl": "https://manage.wrappedgiftcards.com/applewallet/generate/{accountId}/{giftCardId}",
"GoogleWalletUrl": "https://manage.wrappedgiftcards.com/googlewallet/generate/{accountId}/{giftCardId}",
"BuyerName": "John Buyer",
"BuyerEmail": "[email protected]",
"GiftToFriendUrl": "https://manage.wrappedgiftcards.com/public/gift-to-friend/{giftCardId}",
"ViewBalanceUrl": "https://manage.wrappedgiftcards.com/pc/check-balance/{accountId}?code={code}",
"GiftCardMessage": "Happy birthday!",
"WebhookTopic": "giftcard/updated",
"PdfUrl": "https://manage.wrappedgiftcards.com/Giftcard/Pdf/{giftCardId}",
"IsPromotional": false,
"GiftCardBatchId": null,
"AutomationId": null,
"ApiEventName": null,
"ApiEventProperties": null,
"CampaignId": null,
"Status": "Active",
"IsStoreCredit": false
}
If a verification token is configured when creating the webhook, the payload is signed using an HMAC SHA-256 signature and included in the HMAC-Signature-SHA256 request header. This allows recipients to verify the request originated from our system.