DJEP Node.js SDK

Official Node.js SDK for the DJ Event Planner (DJEP) REST API.

Requirements

• Node.js 14 or later
• No external dependencies

Installation

Via npm

npm install @djeventplannerhub/djep-sdk

Manual Installation

Download the SDK and require it directly:

const DJEP = require('./djep-node-sdk');

Quick Start

const DJEP = require('@djeventplannerhub/djep-sdk');

// Load your API key from environment variables (never hardcode keys)
const djep = new DJEP(process.env.DJEP_API_KEY, process.env.DJEP_DOMAIN);

// Check API status
const status = await djep.status();
console.log(status.data.api_version);

// List upcoming events
const events = await djep.events.list({ status: 'Booked', per_page: 10 });
events.data.forEach(event => {
  console.log(`${event.event_type} on ${event.event_date}`);
});

Authentication

Your API key is generated in DJEP under Setup > Integrations > API Key.

Important: Never hardcode your API key in source files. Use environment variables.

// Environment variable (recommended)
const djep = new DJEP(process.env.DJEP_API_KEY, process.env.DJEP_DOMAIN);

// Or from a .env file (using dotenv)
require('dotenv').config();
const djep = new DJEP(process.env.DJEP_API_KEY, process.env.DJEP_DOMAIN);

Usage

Events

// List events
const events = await djep.events.list({ status: 'Booked', sort_by: 'event_date' });

// Get a single event
const event = await djep.events.get(56789);

// Create an event (financials auto-calculated from package)
const newEvent = await djep.events.create({
  clientid: 12345,
  event_date: '2026-09-15',
  event_type: 'Wedding',
  start_time: '3:00 PM',
  end_time: '11:00 PM',
  addons: '501:2,502:1',
});
console.log(`Total fee: ${newEvent.data.financials.total_fee}`);

// Update specific fields
await djep.events.update(56789, { status: 'Confirmed', guest_count: 200 });

// Update and recalculate financials
await djep.events.update(56789, { pkg_idnumber: 14200 }, true);

// Delete an event (cascading)
await djep.events.delete(56789);

// Event sub-data
const payments = await djep.events.payments(56789);
const songs = await djep.events.musicRequests(56789);
const planning = await djep.events.planning(56789);

Clients

const clients = await djep.clients.list({ per_page: 25 });
const client = await djep.clients.get(12345);

const newClient = await djep.clients.create({
  first_name: 'John',
  last_name: 'Smith',
  email: '[email protected]',
});

await djep.clients.update(12345, { email: '[email protected]' });
await djep.clients.delete(12345);

Venues, Employees, Packages, Addons, Contacts

// All follow the same pattern
const venues = await djep.venues.list();
const venue = await djep.venues.get(789);

const employees = await djep.employees.list();
const packages = await djep.packages.list();
const addons = await djep.addons.list();
const contacts = await djep.contacts.list();

Vendors

const vendors = await djep.vendors.list();
const vendor = await djep.vendors.get(3456);

// Link a vendor to an event
await djep.vendors.linkToEvent(56789, 3456);

Payments

// List all payments company-wide
const payments = await djep.payments.list({ per_page: 50 });

// Add a payment to an event
const result = await djep.payments.addToEvent(56789, 500, 'Credit Card', {
  processing_fee: 15,
  comments: 'Final payment',
});
console.log(`Balance due: ${result.data.balance_due}`);

Music Requests

// Get requests for an event
const songs = await djep.musicRequests.forEvent(56789);

// Add a music request
await djep.musicRequests.add(56789, 'Queen', 'Bohemian Rhapsody', 'MPL');
await djep.musicRequests.add(56789, 'ABBA', 'Dancing Queen', 'DED', 'For the bride');

Booking Helpers

// List available helpers
const helpers = await djep.bookingHelpers.list();

// Run by unique_id (recommended)
const result = await djep.bookingHelpers.run(56789, 'book_event_1');
console.log(result.data.log);

// Or by position index
const result2 = await djep.bookingHelpers.run(56789, null, 0);

Availability

// Check a single date
const avail = await djep.availability.check('09/15/2026');
if (avail.data.available) {
  console.log(`${avail.data.employees.available} employees available`);
}

// Check a date range (max 90 days)
const range = await djep.availability.range('09/01/2026', '09/30/2026');
range.data.dates.forEach(date => {
  console.log(`${date.date}: ${date.available ? 'Available' : 'Unavailable'}`);
});

Settings

const rfiSettings = await djep.settings.websiteTools('request_info');
const company = await djep.settings.company();
const fields = await djep.settings.customFields();

Expenses

const expenses = await djep.expenses.list({ per_page: 25 });
const categories = await djep.expenses.categories();
const payees = await djep.expenses.payees();
const methods = await djep.expenses.paymentMethods();

Other Resources

const rfi = await djep.submissions.rfi();
const quotes = await djep.submissions.quotes();
const contactUs = await djep.submissions.contactUs();

const closedDates = await djep.closedDates.list();
const equipment = await djep.equipment.list();
const systems = await djep.systems.list();

Create Submission (RFI)

Push leads from external sources into the DJ's submissions queue:

// Wedding Wire lead
const submission = await djep.submissions.create({
  first_name: 'Sarah', last_name: 'Johnson',
  email: '[email protected]', telephone: '555-0123',
  event_date: '2026-09-15', event_type: 'Wedding',
  guest_count: 200, source: 'Wedding Wire',
  send_notification: 'true',
});
console.log(`Submission ${submission.data.req_idnumber} created`);

// With custom questions and privacy consent
const submission2 = await djep.submissions.create({
  first_name: 'Emma', last_name: 'Wilson',
  email: '[email protected]',
  event_date: '2027-06-20', event_type: 'Wedding',
  question_1: 'Yes, we need lighting', q1_mapto: 'custom_field1',
  privacy_policy_signed: 'true', source: 'Custom Website',
  send_notification: 'true',
});

Convenience Endpoints

Quick actions without the fields parameter:

// Quick status change — returns old and new status
const result = await djep.events.updateStatus(56789, 'Booked');
console.log(`${result.data.old_status} → ${result.data.new_status}`);

// Assign employee to position (1-15), with optional fee and role
await djep.events.assignEmployee(56789, 1, 48113, { fee: 500, role: 'Lead DJ' });
await djep.events.assignEmployee(56789, 2, 48361, { fee: 350, role: 'MC' });

// Unassign position 3
await djep.events.assignEmployee(56789, 3, 0);

// Update notes — pass any combination of note fields
await djep.events.updateNotes(56789, {
  comments: 'AI Summary: Client wants 80s and 90s hits',
  next_action: 'Send playlist proposal',
  next_action_date: '08/15/2026',
});

Auto-Pagination

For resources with pagination, use all() to automatically iterate through every page:

// Fetches all events across all pages
for await (const event of djep.events.all({ status: 'Booked' })) {
  console.log(event.event_date);
}

// Works with any paginated resource
for await (const client of djep.clients.all()) {
  console.log(`${client.first_name} ${client.last_name}`);
}

Error Handling

The SDK throws specific errors for different error types:

const { DJEPError, AuthenticationError, NotFoundError, ValidationError, ForbiddenError, RateLimitError } = require('@djeventplannerhub/djep-sdk');

try {
  const event = await djep.events.get(99999);
} catch (err) {
  if (err instanceof AuthenticationError) {
    console.log('Invalid API key');
  } else if (err instanceof NotFoundError) {
    console.log('Event not found');
  } else if (err instanceof ForbiddenError) {
    console.log('Insufficient permissions');
  } else if (err instanceof ValidationError) {
    console.log('Invalid parameters');
  } else if (err instanceof RateLimitError) {
    console.log('Too many requests');
  } else if (err instanceof DJEPError) {
    console.log(`API error: ${err.message}`);
  }
}

Configuration Options

const djep = new DJEP(process.env.DJEP_API_KEY, process.env.DJEP_DOMAIN, {
  timeout: 60000, // Request timeout in milliseconds (default: 30000)
});

Security

• Never commit API keys to version control
• Store keys in environment variables or .env files (excluded from Git)
• Use the most restrictive API key for your use case
• API keys provide full access to the associated account — treat them like passwords

API Documentation

Full API documentation is available at your DJEP instance:

https://yourdomain.com/api/api.asp?action=docs

License

MIT