Skip to content
GRIN Classic Help Center home
InboxAsk a human

Installing the GRIN Magento Module

Updated by Dan

To finish integrating with Magento, you must install GRIN's Magento Module. This will allow GRIN to fully access your Magento instance, its products, and more so you can seamlessly use Magento within GRIN.

The full installation process consists of three parts:

  1. Installation

  2. Configuration

  3. Webhook verification

All of these parts, as well as an additional Troubleshooting section, will be described below.

Note: We highly recommend your Magento Admin completes the module setup. If you need further assistance, reach out to GRIN's Support team.

What You'll Need

  • A webhook authentication token. To get a token, you must first integrate with Magento, and then contact GRIN Support to obtain the token. For more information on integrating with Magento, see our help article Integrating with Magento.

  • Composer v1, which you can download directly from Composer. If your server is running Composer 2.X, you can download Composer v1 to the working directory, then explicitly use the v1 executable with any composer command by specifying ./composer.phar for any composer-related commands.

How to Do It

Installation

1. SSH to your Magento store.

2. Navigate to the root directory.

3. Run the following commands to install and enable the module.

The GRIN Module should now be installed in your Magento 2 store instance.

Configuration

Once you've installed the GRIN Magento Module, you must configure the module to work with your store.

1. Log in to your Magento 2 Admin Dashboard.

2. Navigate to Stores > Configuration.

3. Navigate to Services > GRIN (Influencer Marketing).

4. Set the GRIN SDK > Enable field to Yes.

5. Set the Cart Widget > Enable field to No.

6. Set the Webhooks > Enable field to Yes.

7. Enter your webhook authentication token in the Webhooks > Webhook authentication token field.

8. Click Sales.

9. Click Shipping Methods.

10. Set the GRIN Influencer Shipping > Enabled field to Yes.

Your GRIN Module is now configured to work with your Magento 2 store instance.

Webhook Verification

1. Generate a webhook message by modifying the quantity or description of an existing product.

2. Navigate to System > GRIN Module Queue Messages.

3. Confirm the Status with each record reads as Complete.

Troubleshooting

If the Statuses of your records appear as New or Error when verifying your webhooks, you can check the following solutions to troubleshoot. If you continue to have errors, contact GRIN Support.

Run the Magento 2 Cron Processes

The grin webhook process may need to be killed and the Magento CLI cron command should be run.

Manually Add Webhook to the Cron

The grin_module_webhook may not have been automatically added to the cron. If this is the case, confirm that the queue job was added to the /app/etc/env.php file, then add it if missing.

That's it! The GRIN Magento Module should now be successfully installed and configured. Now, you'll be able to utilize your Magento store within GRIN.