Events - MailGlyph Docs

Use a public key for tracking events, and a secret key for listing event names.

Track an event (`events.track`)

import MailGlyph from 'mailglyph';

const tracker = new MailGlyph(process.env.MAILGLYPH_PUBLIC_KEY as string);

const result = await tracker.events.track({
  email: '[email protected]',
  event: 'purchase',
  subscribed: true,
  data: {
    product: 'premium',
    amount: 99
  }
});

console.log(result.success, result.data.timestamp);

List event names (`events.listNames`)

import MailGlyph from 'mailglyph';

const client = new MailGlyph(process.env.MAILGLYPH_SECRET_KEY as string);

const { eventNames } = await client.events.listNames();

console.log(eventNames);

List event names with alias (`events.getNames`)

getNames() is an alias for listNames():

const { eventNames } = await client.events.getNames();

console.log(eventNames);

See endpoint details in the Track event API reference and List event names API reference.