How to Integrate Webhooks with BigMarker

Webhooks are 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. 

Using Bigmarker, whenever someone registers, or the webinar starts or ends, the webhook can see the event, collects the data, and sends it to either an outgoing URL specified by you in the form of an HTTP POST request.  For incoming webhooks, the webhook will receive and collect the data once and event has occurred.

Contents

Why use webhooks

How to enable webhooks

Types of BigMarker webhooks

Why use webhooks

Webhooks are a more straightforward alternative to APIs. While an API provides a comprehensive set of programming commands to interact with an application—allowing you to add, modify, and retrieve data—it requires you to initiate those requests manually. When using an API, your application must be designed to periodically check or request updates from the other application. In contrast, webhooks automatically send data when specific events occur, eliminating the need for constant checking and simplifying the integration process.

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 to Set Up  your 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 you'd like to enable on your webinar

4. Once you enable your webhook, follow the steps below to fully integrate it. 

Types of Webhooks

For an incoming webhook, there are two ways to integrate it:

The first way is to send the Incoming Webhook: Receive incoming request to create webinar registration and BigMarker will save incoming POST request in x-www-form-urlencoded format as a new registrant to your webinar with the following data mapping. 

[
        "conference_id":"26ec9ca26c6f",
        "first_name":"John",
        "last_name":"Doe",
        "email":"john.doe@domain.com",
        "custom_field_utm_medium":"utm_medium",
        "custom_field_utm_source":"utm_source",
        "custom_field_utm_bmcr_source":"utm_bmcr_source",
        "custom_field_State":"State"
]

The second way is to use the Incoming Endpoint and replace the parameters with your registrant data. BigMarker will then save incoming GET request as a new registrant to your webinar.

For outgoing webhooks, follow the steps below 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. For each you will need to provide an outgoing URL where the webhook will send the requests to.

For Outgoing Webhook: New Webinar Registration, BigMarker will send a POST request to this URL with JSON data in the following format every time a new user registers: 

{
    "registration": {
        "bmid":"xxxxxxx",
        "first_name":"John",
        "last_name":"Doe",
        "email":"john.doe@domain.com",
        "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 when the live virtual session starts: 

{
    "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 when the webinar waiting room is closed and the webinar is open, whether that was manual or automatic.: 

{
    "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 when the live virtual session ends: 

{
    "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 when the live virtual session ends:

{
    "attendees": [{
        "bmid":"xxxxxxx",
        "first_name":"John",
        "last_name":"Doe",
        "email":"john.doe@domain.com",
        "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 enters Webinar, BigMarker will send a POST request when a new attendee enters with the JSON data in the following format when an attendee enters the webinar:

For Outgoing Webhook: Attendee watched on demand, BigMarker will send a POST request to this URL with JSON data in the following format when an attendee watches the on-demand webinar:

For Outgoing Webhook: New webinar Create, BigMarker will send a POST request for each new webinar to your URL with the json data in the following format when the webinar is created (best for use in webinar templates):