General implementation

The general implementation connects Cevoid to a store on another ecommerce platform, or to a headless setup, without a dedicated integration. Your catalog comes from product feeds, Cevoid's scripts load your widgets, and your own system sends your orders to the Cevoid API.

Navigate to Settings → Products and markets⁠ to start with your markets and product feeds.

Product feeds bring your products into Cevoid: one or more XML, CSV, or TSV files at a URL for each market. The Cevoid API reads products but doesn't add or change them, so your catalog always comes from your feeds.

Each version of your storefront with its own domain, language, or currency is a market, with feeds of its own. Create the market first: until your workspace has one, Settings → Products and markets⁠ shows New market next to Set up your first product feed and market. See Create a market. Once the market exists, add its feeds, as described in Add a product feed, and start its first sync: see Sync a new market.

After its first sync, Cevoid syncs each feed about once a day, and when you click Sync products on the market. A change in a feed shows in Cevoid after the next sync: see When products sync.

Three scripts load Cevoid's widgets, one for each kind of widget. A page needs the script for each kind of widget it shows. On a headless Shopify storefront, they work the same way.

If your site changes content without a full page reload, the Cevoid script also loads review widgets added later. Galleries and cards need a refresh: see Runtime helpers in the developer docs.

The Cevoid script, which loads review widgets and review forms, goes on every page: review request links open the review form on the start page of the customer's market. It loads nothing until a widget comes close to the visible part of the page.

1. Navigate to Reviews → On-site widgets⁠ and click Script status. The Install the Cevoid script dialog opens. Add script in Things to do on Reviews → Overview⁠ opens it too.
2. Copy the script under Install with code
3. Paste the script right before the closing </head> tag on every page of your site
4. Publish the change to your site
5. Click Check status in the dialog. Each market shows Installed once Cevoid finds the script.

The script carries your workspace's publishable key, which tells Cevoid which workspace the page belongs to:

<script type="module" src="https://widget.cevoid.com/index.js" async data-cevoid-publishable-key="cev_pk_…"></script>

Each review widget's Embed widget dialog, and each review form's embed dialog, show the same script under Embed with code. For each status, see Check the Cevoid script.

The gallery script, which loads galleries and cards, isn't the Cevoid script, so add it even when your site already has that one. The dialogs that Embed gallery and Embed card open don't show it, so copy it from here.

Paste the gallery script once on every page that shows a gallery or a card, in the <head> or right before the closing </body> tag, and publish the change. It loads a gallery or a card into each cevoid-container div on the page.

<script type="module" src="https://gallery.cevoid.com/index.js" defer></script>

The Cevoid script for program widgets loads your program widgets. Every program widget's embed dialog shows it under Embed with code.

1. Navigate to Loyalty → On-site widgets⁠ and open a widget
2. Click Embed. Embed widget opens, or Embed landing page for the Full landing page.
3. Copy the script under 1. Add Cevoid script.
4. Paste the script right before the closing </head> tag on every page with a program widget
5. Publish the change to your site

<script async src="https://autoloader.cevoid.com/autoloader.js" type="module"></script>

Each widget's embed dialog shows its code, with the widget's ID filled in. Paste the code where the widget should appear, on a page that has the widget's script.

Dynamic widgets, such as the product page gallery, show the content of the page they're on. Their code carries data-product, data-collection, data-category, or data-brand, set to auto or to an explicit value. Program widgets take none.

With auto, Cevoid reads the page's URL: on a product page, it looks for the product whose Link in your feed is that URL, or else ends in the same last part of the path. Where the URL doesn't identify the page's product, collection, category, or brand, such as on a storefront with its own routes, set an explicit value instead, such as the product's ID from your feed. The values each widget accepts are in its article.

Widgets show the language, currency, prices, and product links of the market they load in. Cevoid matches the page's URL to your markets' domains, and uses your default market when none matches: see How localization works.

Galleries and cards can also take their market from a data-market attribute with the market's Custom ID, for a storefront whose URLs don't tell its markets apart. For this and their other attributes, see the UGC Widgets developer docs. Review widgets and program widgets have no market attribute.

Members log in to program widgets with Cevoid's email login or with your own. Select the method in Authentication in Settings → Loyalty → General⁠:

• Email authentication by Cevoid: Members enter their email and a verification code that Cevoid sends them. It needs no code on your site, and workspaces not created from a Cevoid Shopify app start with it.
• Custom store authentication: Customers logged in to your site are logged in to your program widgets. Your server signs each customer's ID and email, and the widget code carries the signature: see Custom customer authentication.

For both methods, see Available authentication methods.

Review requests, verified buyers, points for purchases, and tier milestones all depend on your orders. On other platforms, your own system sends each order to the Cevoid API, and updates it when it's fulfilled, delivered, or refunded. Flows that start on Order fulfilled or Order delivered, such as review requests, run on those updates.

For the API key and the request, see Send orders through the API. To check that orders arrive for each market, see Check orders per market.

Session tracking links each visitor's events into visits with a cookie, for visitors whose consent allows it. Without Shopify, your developer passes your cookie banner's choice to Cevoid through Google consent mode or Cevoid's consent flag. If neither is on the page, Cevoid sets the cookie for every visitor once session tracking is on. See Session tracking and consent.

Sales tracking links orders to the content your visitors saw. Without Shopify's checkout web pixel, it's a sales tracking call on your order confirmation page, with Cevoid's analytics SDK: see the General implementation tab of Set up sales tracking.

A flow can send events, such as a fulfilled order or a submitted review, to your own service as signed webhooks: see Webhooks via Flows. Cevoid shares profile data with an ecommerce platform only on Shopify, so your systems read profiles over the Cevoid API: see Where data and events can be shared.

Some features need a native integration. On other platforms:

• Discount codes: Cevoid creates discount codes for rewards only in Shopify. Discount code rewards, including free shipping and free product codes, use codes you upload: see the Manual tab of Discount code: Amount or percentage off.
• Store account login: The authentication method Store account authentication by Shopify needs Shopify, and so do the opt-in rules Store account and Store account and program action. See How opt-in rules work.
• Marketing consent: Orders sent through the API carry no marketing consent. Review requests that Cevoid emails go only to customers who agreed to marketing email, and requests sent through Klaviyo, Voyado, or a webhook aren't checked: see Who gets a review request.
• Rich snippets: Review widgets add the rating's structured data in the shopper's browser, where the Product rating block on Shopify puts it in the page's HTML. See Rich snippets on other platforms.