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.
$ npm install node-mautic
Require the class
const MauticConnector = require('node-mautic');
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.Make calls
Example:
const campaigns = (await mauticConnector.campaigns.listCampaigns()).campaigns;
To run the tests, fill the apiUrl
, username
, and password
fields in MauticConnector.i.test.js
.