DOCSEARCHbyAlgolia
Submit Docs

Fourthwall Developer Documentation

website·Indexed 41 days ago

https://docs.fourthwall.com

Developer resources for Fourthwall, including API references for memberships, channel management, and shop operations. Features documentation on the Model Context Protocol (MCP) server for AI assistants, LLM support for AI code editors, and integration with ChatGPT and Claude to manage shops.

Tokens
40.6K
Snippets
255
Records
341
Agent score
59%

What's inside Fourthwall

  1. Overview of Fourthwall developer integration options

    Fourthwall provides several ways to build integrations, automate shop operations, or create ecosystem apps:

    • Platform API: Used to manage orders, products, memberships, and other backend shop data.
    • Storefront API: Used to build custom storefronts using public shop and product data.
    • Webhooks: Used to receive real-time notifications for events such as new orders and subscriptions.
    • Apps: Used to create integrations that live directly within creator dashboards.

  2. Overview of Fourthwall Platform Integration

    A platform integration allows you to embed Fourthwall merch creation directly into your own UI (e.g., a creator dashboard or link-in-bio tool). Creators can browse templates, upload artwork, and preview products without leaving your app. Your backend handles the provisioning of a Fourthwall shop and the creation of real products on the creator's behalf.

    Note: The Channel API is currently in beta and invite-only. You must request access from Fourthwall to receive a dedicated channel.* client.

  3. Overview of Fourthwall Agency Integration

    An agency integration allows a single operator to manage a fleet of subaccount shops for multiple creators from one console. This is achieved using a single confidential channel.* credential that authenticates in three different ways depending on the target operation. Access to the Channel API is invite-only and currently in beta; agencies must request access from Fourthwall.

  4. Overview of Fourthwall AI App capabilities

    The Fourthwall app allows shop owners to manage their store through natural conversation in ChatGPT or Claude. It uses live shop data to perform actions and renders interactive Fourthwall UI components (product cards, design previews, tables, and upload widgets) directly in the chat. For any action that modifies the shop—such as creating promotions or publishing merch—the assistant requires user confirmation before proceeding.

  5. Overview of the Fourthwall Storefront API

    The Storefront API allows developers to build fully custom shopping experiences on top of Fourthwall product collections. It enables you to integrate Fourthwall's product catalog, fulfillment, and checkout processes into any custom website or application. Key capabilities include fetching products and collections, managing shopping carts via API, and redirecting customers to Fourthwall's hosted checkout page.

  6. Overview of the Fourthwall Channel API

    The Channel API is a shop provisioning and onboarding layer that allows platforms to create Fourthwall shops for creators and onboard them end-to-end. This includes spinning up a shop, inviting the owner, and setting up payouts. Once a shop is created via the Channel API, subsequent operations (like designing products or managing checkouts) are handled by the Platform API and Storefront API. Note: The Channel API is currently in beta and invite-only; you must request access from Fourthwall to obtain a channel.* client ID and secret.

  7. Overview of the Fourthwall Platform API

    The Fourthwall Platform API is a RESTful API used to programmatically manage various aspects of a Fourthwall shop. Depending on the use case, it can be accessed directly via an API key for full access to a single shop, or indirectly via OAuth for applications that need to interact with multiple shops.

  8. Understand the Fourthwall Webhook event structure

    All Fourthwall webhook events share a consistent JSON structure. This structure provides metadata about the event (such as the event type, shop ID, and API version) and a data object containing the specific payload for that event type.
    {
  "testMode": false,
  "id": "weve_geAva6c1RAuyb9HQxbSlmA",
  "webhookId": "wcon_P-VkRfmJTBaC6_Tst22cew",
  "shopId": "sh_7ad0c438-beda-4779-a885-0dc325a755c1",
  "type": "ORDER_PLACED",
  "apiVersion": "V1_BETA",
  "createdAt": "2023-07-12T15:05:11.078089+00:00",
  "data": {
    // Event-specific data
  }
}

  9. Retrieve the current shop details

    Use the GET /open-api/v1.0/shops/current endpoint to retrieve information about the current shop. This endpoint is subject to a rate limit of 100 requests every 10 seconds per shop.
    curl -X GET "https://{your-domain}/open-api/v1.0/shops/current"

  10. Distribute custom iframe sections using App Sections

    App Sections allow you to distribute custom iframe sections as part of your app. Unlike standard embedded sections, App Sections are specified at the app level, meaning any user who installs your app can add the section to their shop.

  11. Retrieve a donation by ID

    Retrieve detailed information about a specific donation using the GET /open-api/v1.0/donations/{donationId} endpoint.

    Constraints & Requirements:

    • Rate Limit: 100 requests every 10 seconds per shop.
    • Authentication: Requires the donation_read OAuth scope. API keys have full access to this endpoint.
    curl -X GET "https://{your-shop-domain}/open-api/v1.0/donations/{donationId}"

  12. Architecture for Fourthwall Streaming Alerts

    A streaming alert system turns shop activity (orders/tips) into on-stream engagement by pushing real-time events to an OBS browser source. The architecture consists of five components:

    1. Install & Webhook Registration: App uses OAuth to subscribe to ORDER_PLACED and DONATION events.
    2. Embedded Settings Page: An iframe in the Fourthwall dashboard where creators manage overlay URLs and toggles.
    3. Webhook Receiver: A signed HTTP endpoint that validates payloads and fans out events to the transport layer.
    4. Push Transport: A long-lived connection (preferably Server-Sent Events/SSE) from the browser source to the server.
    5. Overlay Page: A static HTML/JS page that subscribes to the stream, queues events, and animates them serially.