Install Raysly on Magento

The Raysly module (Raysly_Connect) adds the instant-offer form to your Magento 2 or Adobe Commerce store and can send opted-in checkout customers to your Raysly lead pipeline. Your products, checkout and invoices stay in Magento.

This connector is in beta. Raysly keeps issuing offers and invoices as it does today; invoicing pass-through stays off while the connector is in beta.

Before you start

• You need a Raysly account. If you do not have one yet, create a Raysly account first.
• Magento Open Source or Adobe Commerce 2.4.x (2.4.4 or newer recommended) on PHP 8.1 or newer, with the PHP extensions curl, json and mbstring.
• Your store must be served over HTTPS on the default port (one-click connect needs it; the manual key route does not).
• The web server must be able to reach Raysly over HTTPS, and you need command-line access to run bin/magento.

Install and connect

1. Get the module package. Raysly supplies the package as a ZIP file. Request the current version from Raysly support at support@raysly.com.
2. Install the module files. Either require the package with Composer (until it is published, serve the ZIP from a Composer "artifact" repository: composer config repositories.raysly artifact /path/to/artifacts, then composer require raysly/module-connect:0.1.0), or unzip it into app/code/Raysly/Connect.
3. Enable the module. Run bin/magento module:enable Raysly_Connect, then bin/magento setup:upgrade, then in production mode bin/magento setup:di:compile and bin/magento setup:static-content:deploy -f, and finally bin/magento cache:flush. In developer mode only module:enable, setup:upgrade and cache:flush are needed.
4. Click Connect to Raysly. In the admin open Raysly → Raysly settings (or Stores → Configuration → Raysly) and click Connect to Raysly. Sign in or sign up in Raysly and confirm this store. You are sent back to the store, which finishes the handshake and then redirects you to the admin. Open Raysly settings again to see the status.
5. Add your store to the widget list. In Raysly add the store address to the list under Settings → Website widget, so the form may load there.
6. Choose which checkout customers become leads (optional). Under Lead bridge set Send leads to Raysly to Yes and I confirm a lawful basis for sharing to Yes. Until both are set nothing is sent.
7. Link your products (optional). In the Product sync section click Sync my products to Raysly. See the user guide for exactly what it shares.

What the connection can and cannot do

When you connect, Raysly creates an API key for this store that can only create leads (permission leads:write) and sends it securely to the plugin or module. The key cannot read or change your products, prices, orders, customers or settings. No key travels in a URL, and you never copy or paste one. Disconnecting in the store revokes the key in Raysly.

Connect manually (advanced)

Under Connect manually (advanced) paste the tenant ID, the key with the leads:write permission (Settings → API keys) and the widget host (Settings → Website widget).

If you remove the module

• Disconnect revokes the key in Raysly and deletes it from the store, whatever Raysly answers.
• bin/magento module:uninstall --remove-data Raysly_Connect does the same.
• A key you pasted by hand is not revoked from the store: revoke it under Settings → API keys.

Languages

The module speaks English, German, French, Italian and Greek.