This Nuxt module makes it easy to add the Loops JavaScript SDK to your Nuxt project.

Installation

You can install the package from npm:

npm install nuxt-loops

You will need a Loops API key to use the module.

In your Loops account, go to the API Settings page and click Generate key.

Copy this key and save it in your application code (for example as LOOPS_API_KEY in an .env file).

Then add nuxt-loops to your modules list and add a reference to your API key:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-loops'],
  loops: {
    apiKey: process.env.LOOPS_API_KEY
  }
});

Usage

The Loops API and SDK should only be used on the server side to protect your API key.

To use the module, import loops from the request context.

Then call one of the SDK methods. Read through the JS SDK docs for more details.

export default defineEventHandler(async (event) => {
  const { loops } = event.context;

  const response = await loops.updateContact("hello@gmail.com", {
    firstName: "Bri",
    lastName: "Chambers",
  })
});

See the API documentation to learn more about rate limiting and error handling.


Version history

  • v1.0.0 (Sep 6, 2024) - Initial release.

Was this page helpful?