The official Node.js binding for your favorite SparkPost APIs!
Before using this library, you must have:
npm install sparkpost
new SparkPost(apiKey, options) - Initialization
apiKey
SPARKPOST_API_KEY environment variable)Stringoptions.origin or options.endpoint
Stringhttps://api.sparkpost.com:443options.apiVersion
Stringv1options.headers
Objectoptions - see request modules optionsoptions.uri - can either be a full url or a path that is appended to options.origin used at initialization (url.resolve)callback - executed after task is completed. required
callback(err, data)err - any error that occurreddata.res - full response from request clientdata.body - payload from responseoptions - see request optionscallback - see request optionsPassing in an API key
var SparkPost = require('sparkpost');
var client = new SparkPost('YOUR_API_KEY');
Using an API key stored in an environment variable
process.env.SPARKPOST_API_KEY = 'YOUR_API_KEY';
var SparkPost = require('sparkpost');
var client = new SparkPost();
Specifying non-default options
var SparkPost = require('sparkpost');
var options = {
endpoint: 'https://dev.sparkpost.com:443'
};
var client = new SparkPost('YOUR_API_KEY', options);
We may not wrap every resource available in the SparkPost SDK, for example the Node SDK does not wrap the Metrics resource, but you can use the Node SDK Base Object to form requests to these unwrapped resources. Here is an example request using the base object to make requests to the Metrics resource. Here is an example request using the base object to make requests to the Metrics resource.
// Get a list of domains that the Metrics API contains data on.
var options = {
uri: 'metrics/domains'
};
client.get(options, function(err, data) {
if(err) {
console.log(err);
return;
}
console.log(data.body);
});
Click on the desired API to see usage and more information
client.recipientLists (examples)client.sendingDomains (examples)client.suppressionList (examples)client.templates (examples)client.transmission (examples)client.webhooks (examples)We use Grunt for our task runner, so you will also have to install Grunt globally npm install -g grunt-cli
Run npm install inside the repository to install all the dev dependencies.
Once all the dependencies are installed, you can execute the unit tests using grunt test
[0.9.0] - 2015-05-12 - breaking
FAQs
A Node.js wrapper for interfacing with your favorite SparkPost APIs
The npm package sparkpost receives a total of 18,270 weekly downloads. As such, sparkpost popularity was classified as popular.
We found that sparkpost demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.