Register User for Webinar

Register someone for a webinar. The user does NOT need to exist in Flywheel already: they are found by any supplied identifier (user_id, email, phone or anonymous_id) or created as a new user profile. Registration enrolls the user into every live workflow with a matching Webinar Registration trigger and fires a $fw_webinar_registration event. Repeat registrations for the same user are idempotent and produce no duplicate side effects.

POST /v1/webinars/register

JavaScript

new_user

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Auth-Type': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    webinar_id: '0d4f6f36-2b6a-4c1e-9a6f-1f2d3c4b5a69',
    user: {
      email: '[e-mail]',
      full_name: 'Jane Doe',
      properties: {company: 'Acme', signup_source: 'landing_page'}
    }
  })
};

fetch('https://api.flywheel.cx/v1/webinars/register', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "success": true,
  "registration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "already_registered": true
}

Authorizations

Authorization · string · header · required

Enter your API key obtained from the Flywheel dashboard (without 'Bearer ' prefix)

Auth-Type · string · header · default: api · required

Authentication type header. Must be set to 'api' for all API requests.

Body

application/json

webinar_id · string<uuid> · required

user · object · required

The user to register. At least one identifier (user_id, email, phone or anonymous_id) is required. Unknown users are created; known users are matched and updated.

Show child attributes

Response

200

application/json

Registration created (or already existed)

success · boolean

registration_id · string<uuid>

org_user_id · string<uuid>

The Flywheel id of the matched or newly created user

already_registered · boolean

True if this user was already registered for the webinar