Quick Start

This guide will walk you through connecting your first data source, uploading a process model, and viewing your first conformance dashboard.

1. Create a project

Log in to the Meridian dashboard and click "New Project". Give it a name and select your industry template (or start blank).

2. Install the collector

npm install @meridian/collector

# Initialize in your app
import { MeridianCollector } from '@meridian/collector'

const collector = new MeridianCollector({
  apiKey: process.env.MERIDIAN_API_KEY,
  projectId: 'your-project-id',
})

3. Emit your first event

// Emit a process event
await collector.event({
  caseId: 'INV-2026-001',      // unique identifier for this process instance
  activity: 'Invoice Created',  // what happened
  timestamp: new Date(),
  attributes: {
    amount: 15000,
    vendor: 'Acme Corp',
    region: 'EMEA',
  },
})

4. Upload your process model

Upload a BPMN 2.0 file via the dashboard, or define your reference model using the visual model editor. Meridian will immediately start evaluating incoming cases against it.