API Reference

Using Custom CMS Webhooks

With our Custom CMS integration, you can easily sync Sequel CMS with your own CMS so your marketing team can run everything from Sequel.

📘

Are you using Webflow or WordPress? No need for this custom implementation, you can check our plugins and easily install with those CMS systems: https://www.sequel.io/integrations

How it works

  1. Open the Sequel Dashboard and navigate to Integrations -> Custom CMS Integration
  2. Set the webhook destination for each action
  3. Create URL: - this will be triggered once an event is created
  4. Update URL: - this will be triggered once and event is updated. Look below on how we can store your unique CMS id.
  5. Delete URL: - this will be triggered once and event is deleted

Webhook when creating an event

This trigger is essential for your CMS integration. When an admin creates an event in Sequel, we will send a data structure contains all the information needed to create a CMS entry in your system.

Create Webhook Data Structure

  1. details.companyName: the company name in Sequel
  2. details.eventId: the eventId used in the Sequel embed code. This will ensure you embed the correct event.
  3. details.eventName: the name of the event in Sequel
  4. details.description: the rich text description set in Sequel
  5. details.startDate: the start date and time of the event in UTC
  6. details.endDate: the end date and time on the event in UTC
  7. details.bannerUrl: the banner image url
  8. details.timezone: the timezone of the event in the TZ format (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

Make sure to map the information above to the correct entries in your CMS.

Sync data back to Sequel

Once an entry is created, we strongly recommend calling Sequel so we can update the registration URL with the newly created URL and to store your unique ID for this CMS entry (this is helpful for the update or delete webhooks)

You can call the following endpoint to store the data in Sequel:

POST https://api.introvoke.com/api/v3/events/["eventId"]/wpcms

{
  "postId": "ID_NEWLY_CREATED_CMS",
  "postUrl" : "URL_NEWLY_CREATED_CMS",
}

Make sure to replace the values above:

  1. ["eventId"] - this is the Sequel eventId from the create event webhook
  2. ID_NEWLY_CREATED_CMS - this is your internal ID to identify the CMS entry that was created. For example WordPress uses unique IDs 1, 2, 3, etc.
  3. URL_NEWLY_CREATED_CMS - this is the public URL of the newly created CMS entry so Sequel can send registrations straight to your website
  4. If a URL is set, make sure the entry is published so users can access it.

Embed Sequel on your site

Now that. CMS entry is automatically created in your CMS, you need to ensure the Sequel embed code is running as expected. You can use our generic embed code and replace the eventId with the one sent in the creation webhook 

<script type="text/javascript"> url = parent.document.location.search; document.write('<iframe title="Sequel event" width="100%" height="80vh" src="https://embed.sequel.io/event/["eventId"]' + url + '" frameborder="0" allow="camera *; microphone *; autoplay; display-capture *" allowfullscreen style=" height: 80vh; border-radius: 12px; border: 1px solid #dbdfec; box-shadow: 3px 3px 10px 0 rgb(20 20 43 / 4%); width:100% " > </iframe>'); </script>

👍

Make sure to replace ["eventId"] with the eventId from the creation webhook data structure.

Webhook when updating an event

This will be triggered when an admin changes the event name, banner, description, date or timezone. It is useful to keep your CMS entry up-to-date.

📘

The eventId will never change during an update so your embed will always be accurate.

Update Webhook Data Structure

  1. details.companyName: the company name in Sequel
  2. details.eventId: the eventId used in the Sequel embed code. This will ensure you embed the correct event.
  3. details.eventName: the name of the event in Sequel
  4. details.description: the rich text description set in Sequel
  5. details.startDate: the start date and time of the event in UTC
  6. details.endDate: the end date and time on the event in UTC
  7. details.bannerUrl: the banner image url
  8. details.timezone: the timezone of the event in the TZ format (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
  9. details.externalCMSItemId: the ID of your internal CMS entry if set using the call explained above

The data is very similar to the create webhook but contains an extra externalCMSItemId. This will be helpful to quickly locate your internal CMS entry and update the information accordingly.

Webhook when deleting an event

This will be triggered when an admin deletes an event.

Delete Webhook Data Structure

  1. details.companyId: the company id in Sequel
  2. details.eventId: the eventId used in the Sequel embed code. This will ensure you embed the correct event.
  3. details.externalCMSItemId: the ID of your internal CMS entry if set using the call explained above

Using the externalCMSItemId is the fastest way to ensure you are deleting the correct entry.