API Reference

Welcome to the StealthSeminar API! You can use our API to access specific StealthSeminar API endpoints to get information about upcoming times for a webinar and register leads for webinars. Our API supports our dynamic scheduling, which means you can utilize scheduling features like Just In Time with our API.

We have language bindings in JavaScript and PHP! You can view code examples in the dark area to the right, and you can switch the programming language examples with the tabs in the top right.

Webinar Registration

Get Registration Information

const request = new XMLHttpRequest();
const url = 'https://api.joinnow.live/webinars/:shortId/registration-information';
request.open('GET', url);
request.send();
request.onreadystatechange = function() {
  if (this.readyState === 4 && this.status === 200) {
    console.log(JSON.parse(request.responseText));
  }
};

const https = require('https');

https.get('https://api.joinnow.live/webinars/:shortId/registration-information', res => {
  let data = '';

  // A chunk of data has been received.
  res.on('data', (chunk) => {
    data += chunk;
  });

  // The whole response has been received. Print out the result.
  res.on('end', () => {
    console.log(JSON.parse(data));
  });
}).on('error', (e) => {
  console.error(e);
});

<?php

$curl_handle = curl_init();
curl_setopt($curl_handle, CURLOPT_URL, 'https://api.joinnow.live/webinars/:shortId/registration-information');
curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl_handle);
curl_close($curl_handle);
echo $response;
?>

<?php

$request = new HttpRequest('https://api.joinnow.live/webinars/:shortId/registration-information', HttpRequest::METH_GET);
try {
  $request->send();
  echo $request->getResponseCode();
  echo $request->getResponseBody();
} catch (HttpException $ex) {
  echo $ex;
}
?>

The above command returns JSON structured like this:

{
  "id": "a9831b",
  "title": "Test Webinar",
  "timezone_id": "America/Phoenix",
  "start_date": "2019-01-02T19:00:00.000Z",
  "type": "automated",
  "upcoming_times": [
    "2019-01-03T16:00:00.000Z",
    "2019-01-04T11:00:00.000Z",
    "2019-01-05T19:00:00.000Z"
  ],
  "registrationPages": [],
  "javascript": [],
  "eventTrackingPixels": [],
  "sms_reminders": true,
  "registration_enabled": true,
  "registrationCSS": null,
  "embedLayout": "simple-0",
  "embedCSS": null,
  "gdpr": null,
  "gaNumber": null,
  "thankYouRedirect": null,
  "exitPopup": true,
  "duration": 6186.33
}

GET https://api.joinnow.live/webinars/:shortId/registration-information

URL Parameters

Response Body

Register For A Webinar

const request = new XMLHttpRequest();
const url='https://api.joinnow.live/webinars/:shortId/registration';

const postData = JSON.stringify({
  start_time: '2019-01-18T12:00:00.000Z',
  name: 'Test Name',
  email: 'test@example.com',
  customFields: {
    country: 'US',
    state: 'AZ',
  },
});

request.open('POST', url);
request.setRequestHeader('Content-Type', 'application/json');
request.send(postData);
request.onreadystatechange = function() {
  if (this.readyState === 4 && this.status === 200) {
    console.log(JSON.parse(request.responseText));
  }
};

const https = require('https');

const postData = JSON.stringify({
  start_time: '2019-01-18T12:00:00.000Z',
  name: 'Test Name',
  email: 'test@example.com',
  customFields: {
    country: 'US',
    state: 'AZ',
  },
});

const options = {
  hostname: 'api.joinnow.live',
  port: 443,
  path: '/webinars/:shortId/registration',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': postData.length,
  },
};

const req = https.request(options, res => {
  let data = '';

  // A chunk of data has been received.
  res.on('data', chunk => {
    data += chunk;
  });

  // The whole response has been received. Print out the result.
  res.on('end', () => {
    console.log(JSON.parse(data));
  });
});

req.on('error', e => {
  console.error(e);
});

req.write(postData);
req.end();

<?php

$data = json_encode([
  'start_time' => '2019-01-18T12:00:00.000Z',
  'name' => 'Test Name',
  'email' => 'test@example.com',
  'customFields' => {
    'country' => 'US',
    'state' => 'AZ,
  },
]);

$curl_handle = curl_init();
curl_setopt($curl_handle, CURLOPT_URL, 'https://api.joinnow.live/webinars/:shortId/registration');
curl_setopt($curl_handle, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl_handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl_handle, CURLOPT_HTTPHEADER, [
  'Content-Type: application/json',
  'Content-Length: ' . strlen($data),
]);
$response = curl_exec($curl_handle);
curl_close($curl_handle);
echo $response;
?>

<?php

$data = json_encode([
  'start_time' => '2019-01-18T12:00:00.000Z',
  'name' => 'Test Name',
  'email' => 'test@example.com',
  'customFields' => {
    'country' => 'US',
    'state' => 'AZ,
  },
]);

$request = new HttpRequest('https://api.joinnow.live/webinars/:shortId/registration', HttpRequest::METH_POST);
$request->addHeaders([
  'Content-Type' => 'application/json',
  'Content-Length' => strlen($data);
]);
$request->addRawPostData($data);
try {
  $request->send();
  echo $request->getResponseCode();
  echo $request->getResponseBody();
} catch (HttpException $ex) {
  echo $ex;
}
?>

The above command returns JSON structured like this:

{
  "id": "7db6cc8f-3ca3-4db6-a66c-94f98cc577a8",
  "webinar_id": "917f1507-a9ab-45cb-aa6a-50caf411d9ee",
  "start_time": "2019-01-05T22:23:41.000Z",
  "created_at": "2019-01-04T22:25:15.334Z",
  "replay_start_time": "2019-01-06T02:23:51.300Z",
  "replay_end_time": "2019-01-08T02:23:51.300Z",
  "end_time": null,
  "short_id": "78195e",
  "live_video_url": null,
  "display_start_time": "2019-01-05T22:23:41.000Z",
  "webinar_short_id": "f25d67",
  "attendee": {
    "instance_id": "7db6cc8f-3ca3-4db6-a66c-94f98cc577a8",
    "ip_address": "172.18.0.14",
    "name": "Test Name",
    "nickname": "TestName",
    "email": "test@example.com",
    "email_lower": "test@example.com",
    "registration_page_id": "5ab0cc48-057c-48f8-a76b-3372ad853ad5",
    "short_id": "cf9c73",
    "sms_number": "",
    "link_parameters": {},
    "timezone_id": "America/Phoenix",
    "gdpr_consent": false,
    "custom_fields": {
      "country": "US",
      "state": "AZ"
    },
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36",
    "created_at": "2019-01-04T22:25:15.334Z",
    "id": "f7328cbc-7e5e-418b-814d-ce40adda5998",
    "blocked": false
  }
}

POST https://api.joinnow.live/webinars/:shortId/registration

URL Parameters

Request Body Parameters

Webhooks

Creating a Webhook Endpoint

const app = require('express')();

const bodyParser = require('body-parser');

app.post('/webhook', bodyParser.raw({ type: 'application/json' }), (request, response) => {
  let values;

  try {
    values = JSON.parse(request.body);
  } catch (err) {
    response.status(400).send(`Webhook Error: ${err.message}`);
  }

  switch (values.event) {
    case 'ping':
      // Respond with the authentication challenge
      response.send(values.challenge);
      break;
    case 'register':
      const attendeevalues = values.data;
      // Handle attendee data
      break;
    case 'clickCta':
      const attendeevalues = values.data;
      const ctaId = values.eventParams.ctaId;
      const ctaName = values.eventParams.ctaName;
    // Handle other event types
    default:
      // Unexpected event type
      return response.status(201).end();
  }

  response.json({ received: true });
});

app.listen(8000, () => console.log('Running on port 8000'));

<?php

$payload = @file_get_contents('php://input');
$values = json_decode($payload);

// Handle the event
switch ($values->event) {
    case 'ping':
      // Respond with the authentication challenge
      echo $values->challenge;
      break;
    case 'register':
      $attendeeData = $values->data;
      // Handle attendee data
      break;
    case 'clickCta':
      $attendeeData = $values->data;
      $ctaId = $values->eventParams->ctaId;
      $ctaName = $values->eventParams->ctaName;
      // Handle attendee data
    // Handle other events
    default:
      // Unexpected event type
      http_response_code(201);
      exit();
}

http_response_code(200);

Webhook data is sent as JSON in the POST request body. Type of event, event parameters, and attendee values are included in the request and can be used however you like, after being decoded from JSON.

Create a webhook endpoint on your website in whichever manner works best for you. With a NodeJS framework like Express, you would add a new route with the endpoint URL. With PHP, you might create a new .php file to handle the requests.

StealthSeminar expects that webhook endpoints will respond within 10 seconds of receiving the request payload. If your service takes longer than that to reply, then StealthSeminar terminates the connection and the request is considered failed. If your endpoint needs more time to process the webhook payload, consider offloading the work to a background worker like Resque (Ruby), RQ (Python), or RabbitMQ (Java).

Request Body Parameters

Attendee Data Values

Additional fields can be added to each webinar using the Registration Fields section. These fields will be added to the data object. Each field can be renamed in the webhook plugin configuration.

Webhook Events

Objects

RegistrationPage Object

WebinarJavascript Object

EventTrackingPixel Object