Skip to main content
Below you will find all the webhook event types that are currently supported by Fourthwall. To distinguish between different event types you can use the type field in the Webhook JSON payload.

​
Order placed

Webhook type = ORDER_PLACED 
{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "friendlyId": "D3XZFWPP",
  "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
  "promotionId": "prm_a1bc23",
  "status": "CONFIRMED",
  "email": "[email protected]",
  "emailMarketingOptIn": false,
  "username": "Supporter username",
  "message": "Sample message",
  "amounts": {
    "subtotal": { "value": 5.5, "currency": "USD" },
    "shipping": { "value": 5.5, "currency": "USD" },
    "tax": { "value": 5.5, "currency": "USD" },
    "donation": { "value": 5.5, "currency": "USD" },
    "discount": { "value": 5.5, "currency": "USD" },
    "total": { "value": 5.5, "currency": "USD" }
  },
  "billing": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zip": "12345"
    }
  },
  "shipping": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zip": "12345"
    }
  },
  "offers": [
    {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "name": "My TShirt",
      "slug": "my-tshirt",
      "variant": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "name": "My TShirt",
        "sku": "WDEK-DRE200L",
        "unitPrice": { "amount": 5.5, "currency": "USD" },
        "quantity": 1
      }
    }
  ],
  "source": { "type": "ORDER" },
  "createdAt": "2020-08-13T09:05:36.939Z",
  "updatedAt": "2020-08-13T09:05:36.939Z"
}
source.type values:
  • ORDER - Standard order
  • SAMPLES_ORDER - Order placed with sample budget
  • TWITCH_GIFT_REDEMPTION - Gift redemption event
  • GIVEAWAY_LINKS - Purchase from giveaway link

​
Order updated

Webhook type = ORDER_UPDATED Sent when an order’s status changes. The update.type field indicates what changed (e.g., STATUS).

​
Gift purchase

Webhook type = GIFT_PURCHASE Sent when someone purchases gifts for others.

​
Donation

Webhook type = DONATION 
{
  "id": "don_Kpcjx4HIQ1e4bTIOjX9CsA",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "status": "COMPLETED",
  "email": "[email protected]",
  "username": "supporter username",
  "message": "message from supporter",
  "amounts": {
    "total": { "value": 17.00, "currency": "USD" }
  },
  "createdAt": "2021-07-01T12:00:00Z",
  "updatedAt": "2021-07-01T12:00:00Z"
}

​
Product created

Webhook type = PRODUCT_CREATED Sent when a new product is created in the shop.

​
Product updated

Webhook type = PRODUCT_UPDATED Sent when a product is modified.

​
Membership subscription purchased

Webhook type = SUBSCRIPTION_PURCHASED Sent when supporter purchases a subscription for the first time or re-subscribes after cancellation. 
{
  "id": "251430",
  "email": "[email protected]",
  "nickname": "username",
  "subscription": {
    "type": "ACTIVE",
    "variant": {
      "id": "mtv_3331",
      "tierId": "mt_123",
      "interval": "MONTHLY",
      "amount": { "value": 5.00, "currency": "USD" }
    }
  }
}

​
Membership subscription changed

Webhook type = SUBSCRIPTION_CHANGED Sent when supporter changes subscription tier.

​
Membership subscription expired

Webhook type = SUBSCRIPTION_EXPIRED Sent after the subscription period ends without renewal.

​
Thank you sent

Webhook type = THANK_YOU_SENT 
{
  "id": "ty_3k8rV3C8SNWSj0pS9fDilA",
  "mediaUrl": "https://fourthwall.com/1",
  "contribution": {
    "type": "ORDER",
    "id": "0bd66320-e0f4-4697-86f8-0ff0a51a0d95",
    "shopId": "sh_demo",
    "supporter": {
      "email": "[email protected]",
      "username": "John Doe",
      "message": "test message"
    }
  }
}
contribution.type can be: ORDER, DONATION, or GIFT_PURCHASE.

​
Newsletter subscribed

Webhook type = NEWSLETTER_SUBSCRIBED 
{
  "email": "[email protected]"
}

​
Platform App disconnected

Webhook type = PLATFORM_APP_DISCONNECTED 
{
  "appId": "app_123",
  "shopId": "sh_123"
}

​
Gift draw started

Webhook type = GIFT_DRAW_STARTED 
{
  "id": "gdr_EdJvIXu3SEiXe_QkPavHSA",
  "type": "INITIAL",
  "giveawayId": "giv_EdJvIXu3SEiXe_QkPavHSA",
  "giveawayFriendlyId": "D3XZFWPP",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "durationSeconds": 60,
  "offer": {
    "id": "063c74ae-7290-4a75-bd8b-e9a1c4afe65c",
    "name": "My T-shirt",
    "slug": "my-shirt",
    "description": "super-tshirt",
    "primaryImage": {
      "id": "67e870a5-e002-4e5f-80aa-bb9134fe9a4b",
      "url": "https://cdn.fourthwall.com/image.jpeg",
      "width": 1536,
      "height": 2048
    }
  },
  "amounts": {
    "subtotal": { "value": 2.00, "currency": "USD" },
    "total": { "value": 4.00, "currency": "USD" }
  },
  "email": "[email protected]",
  "username": "test-username",
  "message": "test-message",
  "gifts": [
    {
      "status": "AVAILABLE",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSB",
      "winner": null
    }
  ],
  "createdAt": "2021-01-01T00:00:00Z"
}

​
Gift draw ended

Webhook type = GIFT_DRAW_ENDED Same structure as GIFT_DRAW_STARTED, but with winner information populated: 
{
  "gifts": [
    {
      "status": "AVAILABLE",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
      "winner": {
        "email": null,
        "username": "test-winner-1",
        "selectedAt": "2021-01-01T00:00:00Z",
        "redeemUri": "https://shop.fourthwall.com/redeem"
      }
    }
  ]
}