Skip to main content
WEBHOOK
GiftCardRequested
{
  "topic": "<string>",
  "trigger": "<string>",
  "id": 123,
  "total_credit_issued": "<string>",
  "gift_card_subtotal": "<string>",
  "gift_card_tax": "<string>",
  "gift_card_bonus_credit": "<string>",
  "currency": "<string>",
  "return_id": "<string>",
  "email": "[email protected]",
  "first_name": "<string>",
  "last_name": "<string>",
  "external_order_id": 123,
  "external_order_name": "<string>",
  "external_order_number": 123
}

Body

application/json
​
topic
string

Webhook type

Example:

"giftcard"

​
trigger
string

Event that triggered the webhook

Example:

"giftcard.requested"

​
id
integer | null

Loop gift card ID, null in the case of auto out-of-stock gift cards

Example:

12345

​
total_credit_issued
string

Total credit issued

Example:

"23.50"

​
gift_card_subtotal
string

Gift card value minus taxes and bonus

Example:

"25.00"

​
gift_card_tax
string

Gift card tax applied, "0.00" if no taxes applied

Example:

"0.50"

​
gift_card_bonus_credit
string

Gift card bonus credit applied, "0.00" if no bonus applied

Example:

"1.00"

​
currency
string

Currency of the gift card values

Example:

"USD"

​
return_id
string

Loop return ID

Example:

"23456"

​
email
string<email>

Customer email address

Example:

"[email protected]"

​
first_name
string

Customer first name

Example:

"Eliza"

​
last_name
string

Customer last name

Example:

"Strawberry"

​
external_order_id
integer

External order ID

Example:

1234567890

​
external_order_name
string

External order name

Example:

"#2234"

​
external_order_number
integer | null

External order number

Example:

1234

Response

200

Return a 200 status to indicate that the data was received successfully