Subscribe to Events

{
// event can be one of:
// - VIEW_STEP
// - START_FLOW
// - COMPLETE_FLOW
// - START_CHECKLIST
// - OPEN_CHECKLIST
// - CLOSE_CHECKLIST
// - IDENTIFY_USER
// - CONVERTED
// - NAVIGATE
// - COMPLETE_TASK
type: "VIEW_STEP",

// Current project.
project: {
	id: "ID_OF_PROJECT",
	name: "NAME_OF_PROJECT",
},

// Current flow.
flow: {
	id: "ID_OF_CURRENT_FLOW",
	name: "NAME_OF_CURRENT_FLOW",
},

// Current step.
step: {
	name: "NAME_OF_CURRENT_STEP",
	indx: 0, // Steps start counting at 0!
},

// NOTE: checklist can be undefined if the project
// has no checklist.
checklist: {
	id: "ID_OF_CHECKLIST",
	name: "NAME_OF_CHECKLIST",
},

// Current task (only defined if on checklist).
task: {
  title: "TITLE_OF_TASK",
  id: "ID_OF_TASK",
}

// List of IDs of completed tasks.
completions: ["...", "..."],

// URL that the visitor clicked.
// Only populated if event is NAVIGATE.
url: "",

// shows up at https://app.navattic.com/your-workspace/customers/{customerId}
customerId: "ID_OF_CURRENT_VISITOR",

// a session is scoped to a browser tab, so any action
// performed in that tab is tied to a session
sessionId: "ID_OF_CURRENT_SESSION",

// Technical metadata about the user (ex: browser, device, etc).
clientSideMetadata: ...,

// Attributes that have been identified from the user, grouped
// by the source they come from (i.e. "FORM").
eventAttributes: {
  // The source can be one of
  // - FORM
  // - IDENTIFY
  // - QUERY_PARAMS
  // - SHARE_LINK
  // - ENRICHMENT
  // - OTHER
  "FORM": {
  	    // Example attributes.
  	    "user.email": "steve@apple.com",
  	    "company.fullName": "Steve Jobs"
  	  },
  	  "QUERY_PARAMS": {
  	    // Example attributes.
  	    "utm_source": "linkedin",
  	    ...
  	  },
  	  ...
  	}
}