Skip to content

Area: Developers

Build your integration

This page lists what you build to connect a shop to Releva, in the order to build it. Each step links to the page with the details. If your shop runs on a platform with a Releva app or plugin, step 2 does most of the work for you.

Releva’s recommendations and personalization need four things. Build them first:

  1. The base Releva.push() call on every page of your storefront: who the visitor is and what is in their cart.
  2. product.id on product pages, in the same call.
  3. Your products, sent to Releva and kept current.
  4. Your paid orders, sent to Releva.

On a platform with a Releva app or plugin, installing it covers the browser part. On a custom website, you build all four. Everything else on this page improves results but is not needed to go live. One exception: if data protection law applies to your shop, handle consent (step 4) before you go live.

Every shop has two keys on Settings › Shop & Integration, on the General tab:

  • The Access Token identifies your shop in the browser and in apps. It appears in your page source by design.
  • The Secret Key authenticates your server’s calls. Keep it on your server only.

Mixing up the two keys is the most common integration error. Both are UUIDs, so they look alike.

Pick your platform. Each page covers the install, what the app or plugin sends, and a check at the end.

Install Releva only once per page. Do not add the JavaScript snippet by hand on a shop where a Releva app or plugin already loads it.

These calls run on your server with the Secret Key. Check your platform’s page first: an app or plugin may already send some of them. The product ids you send here must be the same ids your storefront sends in product.id and in the cart. That is what ties browsing to your catalog.

Call When you call it Needed?
Create or update products Whenever a product changes: price, stock, name or custom fields Required
Report paid orders When an order is paid Required
Let Releva pull your catalog An endpoint you build. Releva calls it on a schedule to read your whole catalog and repair anything a missed update left stale. Recommended
Report refunds When an order is refunded If you take refunds
Update product availability When only a product’s availability changes Optional
Delete a product When a product is gone for good Optional
Send order status updates When an order’s status changes in your shop Optional

Build the parts that apply to your shop:

  1. Open a page of your shop with your browser’s developer tools on the Network tab, filtered to push. Each page sends one POST to https://releva.ai/api/v0/push/ followed by your Access Token, and it answers 200.
  2. Follow Check that your store data arrives to find your page views, products and customers in the Releva admin.
  3. For a mobile app, follow Check that your mobile app is connected.

When the checks pass, Releva has what it needs. Next, you can send events that are specific to your business with Send custom events.