Skip to main content

Quick Start Guide

This guide will get you sending your first campaign in under 5 minutes.

Prerequisites​

  • A Joryio account (sign up at joryio.com)
  • Access to your website's code (for SDK integration)

Step 1: Install the SDK (2 minutes)​

Via npm​

npm install @joryio/web-sdk

Or via script tag (served from the Joryio API)​

<script src="https://api-eu1.joryio.com/sdk/web/latest/joryio.min.js"></script>

Initialize in your app​

import JoryioSDK from '@joryio/web-sdk';

const joryio = new JoryioSDK({
  sdkKey: 'jry_sdk_web_your_key_here' // Get this from Settings → Apps
});

// Identify users when they log in
joryio.identify('user_123');
joryio.setAttributes({
  email: 'user@example.com',
  name: 'John Doe',
});

// Track events
joryio.track('Page Viewed', {
  page: 'Homepage'
});
Get Your SDK Key

Go to Settings → Apps in the Joryio dashboard to create an app and get your SDK key.

Step 2: Email provider (provisioned by your administrator)​

The email provider (SendGrid, SES, etc.) is sending infrastructure - your Joryio administrator sets it up for your organization in the admin console; you don't configure provider credentials from your dashboard. If email isn't sending yet, ask your administrator to provision a provider.

Supported Providers
  • SendGrid
  • Bird (Reach API)
  • AWS SES
  • Mailgun
  • SMTP (any provider)

Step 2.5: Add a sender identity (1 minute)​

Your administrator first attaches and verifies a sending domain (SPF/DKIM) - you can see its health under Analytics → Deliverability. Then create the address your emails come from:

  1. Go to Settings → Email Configuration
  2. Click Add Configuration
  3. Set a display name + local part, and pick a verified domain from the dropdown (e.g. news@yourdomain.com)
  4. (Optional) set it as the default sender

See Email Configuration for managed Reply-To / BCC lists and per-variant senders.

Step 3: Create Your First Segment (1 minute)​

  1. Navigate to Audience → Segments
  2. Click Create Segment
  3. Name it "All Users"
  4. Leave filters empty (matches everyone)
  5. Click Create Segment

Step 4: Send Your First Campaign (1 minute)​

  1. Go to Campaigns
  2. Click Create Campaign and pick the Email campaign type
  3. Walk the wizard steps:
    • Details: name it "Welcome Email"
    • Compose: subject "Welcome to our app!" + your welcome message
    • Audience: select the "All Users" segment
  4. Click Send Test Email on your variant to preview
  5. On the Summary step, click Launch campaign

Congratulations! You just sent your first campaign.

Next Steps​

Track More Events​

Add event tracking throughout your app:

// User signup
joryio.track('Signup Completed', {
  plan: 'free',
  source: 'website'
});

// Feature usage
joryio.track('Feature Used', {
  feature: 'export',
  format: 'csv'
});

// Purchases
joryio.track('Order Completed', {
  order_id: 'order_123',
  total: 99.99,
  items: 3
});

Create Advanced Segments​

Build segments based on user behavior:

Target users where:
- plan = "trial"
AND
- signup_date is within last 14 days
AND
- has NOT performed "Order Completed"

Build Automated Journeys​

Create a journey for automated onboarding:

  1. Go to User Journeys → Create User Journey
  2. Set an event trigger (e.g. your signup event)
  3. Add welcome email (immediate)
  4. Add delay (2 days)
  5. Add feature tutorial email
  6. Activate the journey

Common Issues​

Events not showing up?​

  • Check your SDK key is correct
  • Enable debug mode: new JoryioSDK({ sdkKey, enableDebug: true })
  • Check browser console for errors

Emails not sending?​

  • Ask your administrator to confirm an email provider is provisioned
  • Check the sender is on a verified domain
  • Review campaign status

Need Help?​

You're all set! Start building powerful marketing automation workflows.