Webhooks Integration Guide

New as of 09/20/2022: Retrieve data with Webhooks from: new webinar registrations, webinar start times, when the webinar waiting room opens, webinar end times, live webinar attendee data, and on-demand recordings. Note: These data points are available to Enterprise and Event Package plans. If interested, please contact our Events Experts at [e-mail] 

Webhooks are basically user-defined HTTP callbacks (or small code snippets linked to a web application) that are triggered by specific events. They allow your applications to transfer data instantly and seamlessly to one another. 

So whenever someone registers for your BigMarker webinar, the webhook sees the event, collects the data, and sends it to an outgoing URL specified by you in the form of an HTTP POST request.  

Per Zapier: "Webhooks are similar to APIs—but simpler. An API is a full language for an app with functions or calls to add, edit, and retrieve data. The difference is, with an API, you have to do the work yourself. If you build an application that connects to another with an API, your application will need to have ways to ask the other app for new data when it needs it." 

"Webhooks, on the other hand, are for one specific part of an app, and they're automated. You might have a webhook just for new contacts—and whenever a new contact is added, the application will push the data to the other application's webhooks URL automatically. It's a simple, one-to-one connection that runs automatically." 

Learn how to create webhooks between BigMarker and your server below. (For more in-depth information on webhooks, consult Zapier's guide.)

How Can I Set Up My Webhooks Integration? 

Before you create an outgoing webhook, you'll need to set up an outgoing URL, an HTTP/HTTPS endpoint on your server that accepts JSON payloads. E.g. https://api.yourservice.com/callback. 

1. Log into your webinar and select the Integrations tab. 

2. Scroll down and select Webhooks.

3. Toggle the Webhook integration on. 

4. Once you enable your webhook, enter your desired Outgoing URL into the corresponding prompt that appears. 

Whenever someone registers for your BigMarker event, BigMarker will send a POST request to this URL with json data in the following format:  

{
    "registration": {
        "bmid":"xxxxxxx",
        "first_name":"John",
        "last_name":"Doe",
        "email":"[e-mail]",
        "time_stamp":"2017-01-01T00:00:00Z",
        "custom_field_Job_Title":"Job Title "
    }
}

(Note: Custom registration fields will start with prefix: custom_field_, as seen above.)

5. Enter your Incoming Endpoint into the matching prompt below. 

BigMarker will save incoming POST requests in x-www-form-urlencoded format as a new registrant to your webinar with the following data mapping.

[
        "first_name":"John",
        "last_name":"Doe",
        "email":"[e-mail]",
        "custom_field_Job_Title":"Job Title "
]

Follow the same steps above to retrieve data from the following: new webinar registrations, webinar start times, when the webinar waiting room opens, webinar end times, live webinar attendee data, and on-demand recordings.

Note: These data points are available to Enterprise and Event Package plans. If interested, please contact our Events Experts at [e-mail]

For Outgoing Webhook: New Webinar Registration, BigMarker will send a POST request to this URL with json data in the following format: 

{
    "registration": {
        "bmid":"xxxxxxx",
        "first_name":"John",
        "last_name":"Doe",
        "email":"[e-mail]",
        "conference_id":"fe62abf98a78",
        "enter_url": "https://www.bigmarker.com/integrationstesting/Webhooks?bmid=xxxxxxx",
        "source": "source of registration",
        "referral_domain": "example.com",
        "tracking_code": "value of utm_bmcr_source URL param",
        "time_stamp":"2017-01-01T00:00:00Z",
        "custom_field_Custom_Field":"Custom Field",
        "custom_field_Title":"Title",
        "custom_field_Company":"Company"
    }
}

For Outgoing Webhook: Webinar Start, BigMarker will send a POST request to this URL with json data in the following format: 

{
    "webinar_start_time": {
        "conference_id":"xxxxxxx",
        "start_time":"yyyy-mm-dd hh:mm",
        "conference_url":"https://url_to_conference""
    }
}

For Outgoing Webhook: Webinar Opens from waiting room, BigMarker will send a POST request to this URL with json data in the following format: 

{
    "waiting_room_open": {
        "conference_id":"xxxxxxx",
        "open_time":"yyyy-mm-dd hh:mm",
        "conference_url":"https://url_to_conference"
    }
}

For Outgoing Webhook: Webinar Ends, BigMarker will send a POST request to this URL with json data in the following format: 

{
    "webinar_end_time": {
        "conference_id":"xxxxxxx",
        "end_time":"yyyy-mm-dd hh:mm",
        "conference_url":"https://url_to_conference"
    }
}

For Outgoing URL: Send live webinar attendee data, BigMarker will send a POST request to this URL with json data in the following format:

{
    "attendees": [{
        "bmid":"xxxxxxx",
        "first_name":"John",
        "last_name":"Doe",
        "email":"[e-mail]",
        "conference_id":"xxxxxxxxx",
        "webinar_title":"Title of Webinar",
        "enter_time": "2022-09-13T09:11:52Z",
        "last_leave_time": "2022-09-13T010:11:52Z",
        "total_duration":"[seconds attended webinar]",
        "engaged duration":"[seconds engaged]",
    }, ... ]
}

For Outgoing Webhook: Attendee watched on demand, BigMarker will send a POST request to this URL with json data in the following format:

{
    "on_demand_viewer": {
        "bmid":"xxxxxxx",
        "first_name":"John",
        "last_name":"Doe",
        "email":"[e-mail]",
        "watched_on":"2022-09-13T09:11:52Z",
        "conference_id":"xxxxxxxxx",
        "webinar_title": "Title of Webinar",
        "recording_duration":"[seconds watched webinar]",
    }
}