DashX Node

DashX Node.js SDK

Install

yarn add @dashx/node

Usage

const DashX = require('@dashx/node');

// Initialize DashX SDK
const dx = DashX.createClient({
  publicKey: process.env.DASHX_PUBLIC_KEY,
  privateKey: process.env.DASHX_PRIVATE_KEY,
});

dx.deliver({ to: 'john@example.com', body: 'Hello World!' })
  .then(_ => console.log('Mail Sent'));

Can also be initialized with no parameters, dashx-node will look for these env variables DASHX_PUBLIC_KEY and DASHX_PRIVATE_KEY.

const DashX = require('@dashx/node');

// Initialize DashX SDK
const dx = DashX.createClient();

Deliver

deliver takes two parameters like so:

dx.deliver('email/welcome', {
  to: ['John Doe <john@example.com>','admin@example.com', 'sales@example.com']
});

The first parameter, contentUrn, can take the following forms:

• <content-type>/<content> This is the Content URN, which points to a piece of Content in Clay. Example: onboarding-email/welcome or email/welcome
• <content-type> This is the Content Type URN, which points to a Content Type in Clay. Example: onboarding-email or email
• <system-content-type> This is the System Content Type URN, which is one of email, push, sms, universal. Useful if you don't have any templates set up in Clay, or want to send an ad-hoc message.

The second parameter, options, can include the following keys:

Name	Type	Specifies
to	string or array of string	List of recipients
cc	string or array of string	List of 'cc' recipients (only applies to email)
bcc	string or array of string	List of 'bcc' recipients (only applies to email)
content	object	Can be used to specify ad-hoc content or override the fields of content fetched from Clay
data	object	Can be any valid json to parse the content

Identify

You can use identify to update user info associated with the provided uid

dx.identify('uid_of_user', {
  firstName: 'John',
  lastName: 'Doe',
  email: 'john@example.com',
  phone: '+1-234-567-8910'
});

For Anonymous User

When you don't know the uid of a user, you can still use identify to add user info like so:

dx.identify({
  firstName: 'John',
  lastName: 'Doe',
  email: 'john@example.com',
  phone: '+1-234-567-8910'
});

identify will automatically append a pseudo-random anonymous_uid in this case.

User info can include the following keys:

Name	Type
firstName	string
lastName	string
email	string
phone	string

Search Content

dx.searchContent('content_type', { returnType: 'all', limit: 10 } /* Content Options */)
  .then(data => console.log(data));

Content Options can include following properties:

Name	Type	Example
language	string	'en_US'
include	array	['character.createdBy', 'character.birthDate']
exclude	array	['directors']
fields	array	['character', 'cast']
preview	boolean
returnType	'all' or 'one'
filter	object	{ name_eq: 'John' }
order	object	{ created_at: 'DESC' }
limit	number
page	number

For example, to get latest contacts with name 'John' you can do:

dx.searchContent('contacts')
  .filter({ name_eq: 'John' })
  .order({ created_at: 'DESC' })
  .preview() // Sets preview to true
  .limit(10)
  .all() /* returnType */

This code is lazy by default and will not be executed until .all() or .one() is called. Hence .all() or .one() should be used at the end of chain.

The above code can also be written as:

dx.searchContent('contacts', {
  returnType: 'all',
  filter: {
    name_eq: 'John'
  },
  order: {
    created_at: 'DESC'
  },
  preview: true,
  limit: 10
});

Fetch Content

dx.fetchContent('content_type/content', { language: 'en_US' } /* Fetch Content Options */)
  .then(data => console.log(data));

Fetch Content Options can include following properties:

Name	Type	Example
language	string	'en_US'
include	array	['character.createdBy', 'character.birthDate']
exclude	array	['directors']
fields	array	['character', 'cast']
preview	boolean

dx.fetchContent('movies/avengers', {
  language: 'en_US',
  include: ['character.created_by'],
  exclude: ['directors'],
  fields: ['character', 'release_date'],
  preview: true
});

Track Events

dx.track('event_name', 'uid_of_user', { hello: 'world' } /* Event data */);

Fetch Item

dx.fetchItem('item_identifier');

Development

• Make sure all the dependencies are installed:

$ lerna bootstrap

• To start dev server with hot reload:

$ yarn start

This will run a dev server that logs out errors and warnings and reloads itself on any file save.

• To create production build:

yarn build

• To publish package, make sure to login on npm cli and commit all the changes before running this:

yarn publish