Campaign Widget

Add token gated experiences to your website.

Campaign Widget requires a Manifold Developers account and API credentials. For more information follow our Getting Started guide.

Current Version

0.2.1

Javascript Library

https://campaign.manifoldxyz.dev/0.2.0/campaign.umd.min.js

Base CSS

https://campaign.manifoldxyz.dev/0.2.0/campaign.css

Required Properties

• data-widget: "m-campaign"

• data-campaign-id: The id of the Campaign you've created

• data-app-name: Your App's Name

• data-client-id: Your App's Client ID

• data-network: The network chain id you wish to use (e.g. Ethereum Mainnet is 1).

• data-grant-type: "signature"

The data-app-name, data-client-id and data-network props MUST match the values used for the Connect Widget or your instantiated instance of the Manifold Ethereum Provider, otherwise the widget will not work.

Peer Dependencies

Version 0.2.0 and above requires Connect Widget (>= 3.0.0).

Overview

Using the Campaign Widget is the easiest way to integrate token gated experiences within your app or site. Campaign Widget builds upon our Connect Wallet widget, using an OAuth connection to query NFT data of your connected users via Manifold APIs. Campaign Widget uses this information in conjunction with configurable token gated “campaigns” managed in the Manifold Developer Portal.

Within each campaign things like start and end date, the tokens required for claim, and the experiences you want to make available can be configured. We've launched token gating in conjunction with Manifold Merch Bridge, our official Shopify App to make token gating products from your Shopify store simple and easy. We've also created an option to run your own token-gated data collection via custom forms so you can gather collector data to use however you please. We'll be adding a number of other cool token gated features down the line as well.

Once a campaign is set, the Connect Wallet and Campaign widgets will need to be embedded within your site, referencing your Client and Campaign IDs from Manifold Developer Portal. From here you’re good to go. Upon campaign start collectors can connect their wallets, navigate through the redemption widget to prove NFT ownership, and finalize their secure checkout or data entry.

Check out a brief demo of the customer experience below and read on for full documentation and instructions for configuring and executing token gated experiences!

Adding the Campaign Widget

You can find detailed instructions on how to install and use widgets for your specific website stack by visiting the Getting Started Guide.