nm

node-mautic

Node.js Mautic API with ES6+async/await

Showing:

Popularity

Downloads/wk

242

GitHub Stars

37

Maintenance

Last Commit

3mos ago

Contributors

10

Package

Dependencies

1

License

Apache-2.0

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

node-mautic

A Node.js Mautic API implemented with ES6 + async/await.

Tested with Node 14 and Mautic 3.1.2. (Should work with Node 10 and Mautic 2.7.x as well.)

This package has only 1 dependency (node-fetch), which has 0 dependencies.

Installation

$ npm install node-mautic

Usage

  1. Require the class

    const MauticConnector = require('node-mautic');
    
  2. Instantiate the object

    const mauticConnector = new MauticConnector({
        apiUrl: 'https://your-url.com',
        username: '...',
        password: '...' ,
        timeoutInSeconds: 5
    });
    
    • apiURL needs to be just the base URL. The /url/ part of the API URL is to be omitted here.
    • username and password are just a normal Mautic user's username and password. There are no separate API users in Mautic.
    • timeoutInSeconds is optional.
  3. Make calls

    Example:

    const campaigns = (await mauticConnector.campaigns.listCampaigns()).campaigns;
    

Features

  • uses basic authentication
  • has methods for all ~200 documented API endpoints
  • has less than 400 lines of code
  • uses async/await (no callback hell)
  • some documentation
  • 6 Jest tests

Tests

To run the tests, fill the apiUrl, username, and password fields in MauticConnector.i.test.js.

Thanks

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial