irritable
Advanced tools
Readme
Iterable API request wrapper for client && node.js
$ npm install irritable --save
// Send event to Iterable
var token = process.env.ITERABLE_TOKEN
var Irritable = require('irritable')({
token: token //API Token
})
Irritable.Events.track({
eventName: 'test',
email: 'test@test.com'
}).then(console.log)
irritable(options) -> objectRequired
Type: string or process.env.ITERABLE_TOKEN
Token / key used to communicate with Iterable API
Optional
Type: string
Default: http://api.iterable.com/api/
Base URL of iterable api.
Optional
Type: number
Default: 3000 ms
Timeout of request life sent to iterable
Optional
Type: string
Default: json
Response type sent back from iterable
irritable.Events -> objectreturns event handler object:
{
track: <fn>,
trackPushOpen: <fn>,
trackConversion: <fn>
}
irritable.Events.track(eventObject) -> promiseSends a validated event object to Iterable.
optional
Type: string
Email associated with the event.
required
Type: string
eventName associated with the event.
optional
Type: string
date / unix timestamp of the associated event.
optional
Type: object
Metadata for the event.
optional
Type: number
campaignId of the event.
optional
Type: number
templateId of the event.
irritable.Events.trackConversion(eventObject) -> promiseSends a validated trackConversion event object to Iterable.
required
Type: string
Email associated with the event.
required
Type: number
campaignId of the event.
optional
Type: string
date / unix timestamp of the associated event.
optional
Type: object
Metadata for the event.
optional
Type: number
templateId of the event.
irritable.Events.trackPushOpen(eventObject) -> promiseSends a validated trackPushOpen event object to Iterable.
required
Type: string
Email associated with the event.
required
Type: string
UserId associated with the event.
required
Type: number
campaignId of the event.
optional
Type: string
date / unix timestamp of the associated event.
optional
Type: object
Metadata for the event.
optional
Type: number
templateId of the event.
FAQs
Unknown package
The npm package irritable receives a total of 0 weekly downloads. As such, irritable popularity was classified as not popular.
We found that irritable demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.