Skip to main content
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",
      "primaryImage": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "url": "https://fourthwall.com/image.png",
        "width": 800,
        "height": 600,
        "transformedUrl": "https://fourthwall.com/image.png"
      }
    },
    "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": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "username": "Johnny123",
    "message": "Sample message"
  }
}

Body

application/json
​
id
string
required

Unique identifier for this webhook event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

​
webhookId
string
required

ID of the webhook configuration that triggered this event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

​
shopId
string
required

ID of the shop that generated this event

Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

​
type
string
required

The event type

Example:

"GIFT_PURCHASE"

​
apiVersion
string
required

API version of the webhook payload

Example:

"V1"

​
createdAt
string<date-time>
required

When this event was created

Example:

"2020-08-13T09:05:36.939+00:00"

​
testMode
any
required

Whether this event was sent in test mode

Example:

false

​
data
Gift Purchase · object
required

Response

200

Event received successfully