{
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"type": "GIFT_PURCHASE",
"apiVersion": "V1",
"createdAt": "2020-08-13T09:05:36.939+00:00",
"testMode": false,
"data": {
"id": "giv_EdJvIXu3SEiXe_QkPavHSA",
"friendlyId": "D3XZFWPP",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"offer": {
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"name": "My t-shirt",
"slug": "my-t-shirt",
"description": "My t-shirt description"
},
"amounts": {
"subtotal": {
"value": 10,
"currency": "USD"
},
"tax": {
"value": 10,
"currency": "USD"
},
"total": {
"value": 10,
"currency": "USD"
},
"profit": {
"value": 10,
"currency": "USD"
},
"prepaidShipping": {
"value": 10,
"currency": "USD"
}
},
"email": "supporter@fourthwall.com",
"quantity": 123,
"gifts": [
{
"id": "gft_EdJvIXu3SEiXe_QkPavHSA",
"orderId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"orderFriendlyId": "D3XZFWPP",
"winner": {
"selectedAt": "2020-08-13T09:05:36.939Z",
"email": "supporter@fourthwall.com",
"username": "Johnny123"
},
"status": "AVAILABLE"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"username": "Johnny123",
"message": "Sample message"
}
}Webhook Events
Gift purchase
Fired when a gift card is purchased.
WEBHOOK
GIFT_PURCHASE
{
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"type": "GIFT_PURCHASE",
"apiVersion": "V1",
"createdAt": "2020-08-13T09:05:36.939+00:00",
"testMode": false,
"data": {
"id": "giv_EdJvIXu3SEiXe_QkPavHSA",
"friendlyId": "D3XZFWPP",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"offer": {
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"name": "My t-shirt",
"slug": "my-t-shirt",
"description": "My t-shirt description"
},
"amounts": {
"subtotal": {
"value": 10,
"currency": "USD"
},
"tax": {
"value": 10,
"currency": "USD"
},
"total": {
"value": 10,
"currency": "USD"
},
"profit": {
"value": 10,
"currency": "USD"
},
"prepaidShipping": {
"value": 10,
"currency": "USD"
}
},
"email": "supporter@fourthwall.com",
"quantity": 123,
"gifts": [
{
"id": "gft_EdJvIXu3SEiXe_QkPavHSA",
"orderId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"orderFriendlyId": "D3XZFWPP",
"winner": {
"selectedAt": "2020-08-13T09:05:36.939Z",
"email": "supporter@fourthwall.com",
"username": "Johnny123"
},
"status": "AVAILABLE"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"username": "Johnny123",
"message": "Sample message"
}
}Body
application/json
Unique identifier for this webhook event
Example:
"00aa4abd-5778-4199-8161-0b49b2f212e5"
ID of the webhook configuration that triggered this event
Example:
"00aa4abd-5778-4199-8161-0b49b2f212e5"
ID of the shop that generated this event
Example:
"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"
The event type
Example:
"GIFT_PURCHASE"
API version of the webhook payload
Example:
"V1"
When this event was created
Example:
"2020-08-13T09:05:36.939+00:00"
Whether this event was sent in test mode
Example:
false
Show child attributes
Show child attributes
Response
200
Event received successfully