Skip to main content

Webhook Event Types

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

JSON Model

{
  "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": "supporter@fourthwall.com",
  "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",
      "address2": "string",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zip": "12345",
      "phone": "123456789"
    }
  },
  "shipping": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "address2": "string",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zip": "12345",
      "phone": "123456789"
    }
  },
  "offers": [
    {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "name": "My TShirt",
      "slug": "my-tshirt",
      "description": "Sample description",
      "primaryImage": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "url": "https://fourthwall.com/image.png",
        "width": 800,
        "height": 600
      },
      "variant": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "name": "My TShirt",
        "sku": "WDEK-DRE200L",
        "unitPrice": {
          "amount": 5.5,
          "currency": "USD"
        },
        "quantity": 1,
        "price": {
          "amount": 5.5,
          "currency": "USD"
        },
        "attributes": {
          "description": "Black, L",
          "color": {
            "name": "Black",
            "swatch": "#000000"
          },
          "size": {
            "name": "L"
          }
        }
      }
    }
  ],
  "source": {
    "type": "ORDER"
  },
  "createdAt": "2020-08-13T09:05:36.939Z",
  "updatedAt": "2020-08-13T09:05:36.939Z"
}

Order updated​

Webhook type = ORDER_UPDATED

JSON Model

{
  "order": {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
      "friendlyId": "D3XZFWPP",
      "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
      "promotionId": "prm_a1bc23",
      "status": "SHIPPED",
      "email": "supporter@fourthwall.com",
      "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",
          "address2": "string",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "zip": "12345",
          "phone": "123456789"
        }
      },
      "shipping": {
        "address": {
          "name": "Joe Doe",
          "address1": "Main Street 1",
          "address2": "string",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "zip": "12345",
          "phone": "123456789"
        }
      },
      "offers": [
        {
          "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "name": "My TShirt",
          "slug": "my-tshirt",
          "description": "Sample description",
          "primaryImage": {
            "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
            "url": "https://fourthwall.com/image.png",
            "width": 800,
            "height": 600
          },
          "variant": {
            "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
            "name": "My TShirt",
            "sku": "WDEK-DRE200L",
            "unitPrice": {
              "amount": 5.5,
              "currency": "USD"
            },
            "quantity": 1,
            "price": {
              "amount": 5.5,
              "currency": "USD"
            },
            "attributes": {
              "description": "Black, L",
              "color": {
                "name": "Black",
                "swatch": "#000000"
              },
              "size": {
                "name": "L"
              }
            }
          }
        }
      ],
      "source": {
        "type": "ORDER"
      },
      "createdAt": "2020-08-13T09:05:36.939Z",
      "updatedAt": "2020-08-13T09:05:36.939Z"
    },
    "update": {
      "type": "STATUS"
    }
}

Gift purchase​

Webhook type = GIFT_PURCHASE

JSON Model


{
  "id": "giv_EdJvIXu3SEiXe_QkPavHSA",
  "friendlyId": "D3XZFWPP",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "offer": {
    "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
    "name": "My TShirt",
    "slug": "my-shirt",
    "description": "Sample description",
    "primaryImage": {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "url": "https://fourthwall.com/image.png",
      "width": 800,
      "height": 600
    }
  },
  "amounts": {
    "subtotal": {
      "value": 2.00,
      "currency": "USD"
    },
    "tax": {
      "value": 3.00,
      "currency": "USD"
    },
    "total": {
      "value": 4.00,
      "currency": "USD"
    },
    "paidBySupporter": {
      "value": 5.00,
      "currency": "USD"
    },
    "profit": {
      "value": 6.00,
      "currency": "USD"
    },
    "prepaidShipping": {
      "value": 7.00,
      "currency": "USD"
    }
  },
  "email": "supporter@fourthwall.com",
  "username": "Supporter username",
  "message": "Sample message",
  "gifts": [
    {
      "status": "REDEEMED",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
      "orderId": "7b83a86f-9221-4416-b739-ef88870f999b",
      "orderFriendlyId": "F2LGPYCV",
      "winner": {
        "email": "winner@fourthwall.com",
        "username": "winner-1"
      }
    },
    {
      "status": "AVAILABLE",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSB",
      "winner": {
        "email": null,
        "username": "winner-2"
      }
    },
    {
      "status": "AVAILABLE",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSC",
      "winner": null
    },
    {
      "status": "CANCELLED",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSD",
      "winner": {
        "email": null,
        "username": "winner-3"
      }
    },
    {
      "status": "CHANGED_TO_PROMOTION",
      "id": "gft_EdJvIXu3SEiXe_QkPavHSE",
      "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
      "winner": {
        "email": null,
        "username": "winner-4"
      }
    }
  ],
  "createdAt": "2020-08-13T09:05:36.939Z"
}

Donation​

Webhook type = DONATION

JSON Model

{
  "id": "don_Kpcjx4HIQ1e4bTIOjX9CsA",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "status": "COMPLETED",
  "email": "supporter@fourthwall.com",
  "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

JSON Model

{
  "id": "b2c201d3-8104-4b2a-b2c9-1f6b335b650a",
  "name": "New T-shirt",
  "slug": "new-t-shirt",
  "description": "desc",
  "state": {
    "type": "AVAILABLE"
  },
  "images": [
    {
      "id": "67e870a5-e002-4e5f-80aa-bb9134fe9a4b",
      "url": "https://fourthwall.com/image.png",
      "width": 1536,
      "height": 2048
    }
  ],
  "variants": [
    {
      "id": "e3c12d65-a3aa-417e-a289-dabf71a87194",
      "name": "New T-shirt - White, S",
      "sku": "Z3YD-8CTV00S",
      "unitPrice": {
        "value": 5.00,
        "currency": "USD"
      },
      "attributes": {
        "description": "White, S",
        "color": {
          "name": "White",
          "swatch": "#FFFFFF"
        },
        "size": {
          "name": "S"
        }
      },
      "stock": {
        "type": "LIMITED",
        "inStock": 5
      },
      "weight": {
        "value": 1.00,
        "unit": "kg"
      },
      "dimensions": {
        "length": 1.00,
        "width": 2.00,
        "height": 3.00,
        "unit": "cm"
      },
      "images": [
        {
          "id": "67e870a5-e002-4e5f-80aa-bb9134fe9a4b",
          "url": "https://fourthwall.com/image.png",
          "width": 1536,
          "height": 2048
        }
      ]
    }
  ],
  "createdAt": "2021-07-01T12:00:00Z",
  "updatedAt": "2021-07-01T12:00:00Z"
}

Product updated​

Webhook type = PRODUCT_UPDATED

JSON Model

{
  "product": {
    "id": "b2c201d3-8104-4b2a-b2c9-1f6b335b650a",
    "name": "New T-shirt",
    "slug": "new-t-shirt",
    "description": "desc",
    "state": {
      "type": "AVAILABLE"
    },
    "images": [
      {
        "id": "67e870a5-e002-4e5f-80aa-bb9134fe9a4b",
        "url": "https://fourthwall.com/image.png",
        "width": 1536,
        "height": 2048
      }
    ],
    "variants": [
      {
        "id": "e3c12d65-a3aa-417e-a289-dabf71a87194",
        "name": "New T-shirt - White, S",
        "sku": "Z3YD-8CTV00S",
        "unitPrice": {
          "value": 5.00,
          "currency": "USD"
        },
        "attributes": {
          "description": "White, S",
          "color": {
            "name": "White",
            "swatch": "#FFFFFF"
          },
          "size": {
            "name": "S"
          }
        },
        "stock": {
          "type": "LIMITED",
          "inStock": 5
        },
        "weight": {
          "value": 1.00,
          "unit": "kg"
        },
        "dimensions": {
          "length": 1.00,
          "width": 2.00,
          "height": 3.00,
          "unit": "cm"
        },
        "images": [
          {
            "id": "67e870a5-e002-4e5f-80aa-bb9134fe9a4b",
            "url": "https://fourthwall.com/image.png",
            "width": 1536,
            "height": 2048
          }
        ]
      }
    ],
    "createdAt": "2021-07-01T12:00:00Z",
    "updatedAt": "2021-07-01T12:00:00Z"
  }
}

Membership subscription purchased​

Webhook type = SUBSCRIPTION_PURCHASED

Send when supporter purchases the subscription for the first time or when subscription has been cancelled and then supporter purchases it again.

JSON Model

{
  "id": "251430",
  "email": "supporter@fourthwall.com",
  "nickname": "username",
  "subscription": {
    "type": "ACTIVE",
    "variant": {
      "id": "mtv_3331",
      "interval": "MONTHLY",
      "amount": {
        "value": 5.00,
        "currency": "USD"
      }
    }
  }
}

Membership subscription changed​

Webhook type = SUBSCRIPTION_CHANGED

Send when supporter changes the subscription, e.g. from one tier to another.

JSON Model

{
  "id": "251430",
  "email": "supporter@fourthwall.com",
  "nickname": "username",
  "subscription": {
    "type": "ACTIVE",
    "variant": {
      "id": "mtv_3331",
      "interval": "MONTHLY",
      "amount": {
        "value": 10.00,
        "currency": "USD"
      }
    }
  }
}

Membership subscription expired​

Send after the period of the subscription is over and there was no renewal.

Webhook type = SUBSCRIPTION_EXPIRED

JSON Model

{
  "id": "251430",
  "email": "supporter@fourthwall.com",
  "nickname": "username",
  "subscription": {
    "type": "CANCELLED",
    "variant": {
      "id": "mtv_3331",
      "interval": "MONTHLY",
      "amount": {
        "value": 10.00,
        "currency": "USD"
      }
    }
  }
}

Thank you sent​

Webhook type = THANK_YOU_SENT

JSON Model

{
  "id": "ty_3k8rV3C8SNWSj0pS9fDilA",
  "mediaUrl": "https://fourthwall.com/1",
  "contribution": {
    "type": "ORDER", // Possible values are [ORDER, DONATION, GIFT_PURCHASE]
    "id": "0bd66320-e0f4-4697-86f8-0ff0a51a0d95",
    "shopId": "sh_demo",
    "supporter": {
      "email": "fw@email.com",
      "username": "John Doe",
      "message": "test message"
    }
  }
}

Newsletter subscribed​

Webhook type = NEWSLETTER_SUBSCRIBED

JSON Model

{
  "email": "test@example.com"
}