Built by

Medusa

Category

Analytics

Version

1.3.7

Last updated

Jul 11, 2023, 18:44:17 PM9 months ago

Segment

Track essential commerce analytics with Segment.
Segment Plugin Documentation | Medusa Website | Medusa Repository

Features

  • Automatic analytics tracking for events related to Orders, Swaps, and Claims.
  • Flexibility to track analytics for custom events or operations.

Prerequisites

How to Install

1. Run the following command in the directory of the Medusa backend:
  npm install medusa-plugin-segment
2. Set the following environment variable in 
Copy to clipboard
.env
:
  SEGMENT_WRITE_KEY=<YOUR_SEGMENT_WRITE_KEY>
3. In 
Copy to clipboard
medusa-config.js
add the following at the end of the 
Copy to clipboard
plugins
array:
  const plugins = [
    // ...
    {
      resolve: `medusa-plugin-segment`,
      options: {
        write_key: process.env.SEGMENT_WRITE_KEY,
      },
    },
  ]

Test the Plugin

1. Run the following command in the directory of the Medusa backend to run the backend:
  npm run start
2. Place an order using a storefront or the Store APIs. You should see the event tracked in Segment.

Additional Resources

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.