API / Embed Documentation

Intro

Why?

Sessionize is the easiest way to build an agenda for your event. But when you build it, you surely want to use it in other places - on your event website, mobile apps, big screens etc.

That's why offer read-only access to your agenda data, in several different formats: JavaScript Embeds, HTML + CSS, pure HTML, XML and JSON.

We also provide WordPress plugin that makes the embeding even easier.

Versions

There are two versions of the API - v1 and v2. This documentation is all about v2.

v1 ("legacy API") is depreciated and will be switched off on 31 Dec 2018. Until then, you can access it inside your event dashboard: Schedule (tab) > Legacy API (link in the right column).

Embed vs API

Embed allows you to include different views of your agenda on your website. All you have to do is include one line of code.

API enables you to access your agenda from code - using JSON or XML formats. You can use server side or client side code to process the data.

Multiple endpoints

You can use unlimited number of API / embed endpoints for each event. Each endpoint can have it's own settings and options.

Embed

What views of my agenda can I put on my website?

You can include table view, grid view, sessions list, speakers list and speaker wall. Click on any to preview.

Can I include these embeds on *any* website?

Yes! The only thing you have to be able to do is insert one line of HTML code. Most CMS allow that out-of-the-box, or your webmaster can do it for you.

If you encounter any issues with styling (some website themes use non-standard styling), please contact our support so we can identify the problem.

How does this code for embed look like?

Here is an example: <script type="text/javascript" src="https://sessionize.com/api/v2/jl4ktls0/view/gridtable"></script>

Can I choose my own colors?

Of course!

Can I choose my own date and time format?

Sure! We support virtually all languages and formats on the planet.

Can I choose what data will be displayed and how?

Yes, we have plenty options to fine tune the appearance.

Can I do my own styling?

Sure - you can embed HTML code only and make it use your own CSS.

How to start?

Open your event dashboard, click on "Schedule" tab and you'll find a blue "Embed Schedule on your Web" button on the right. Click it and follow the instructions on the screen!

I have no event. How do I try all of this?

Just click here, and after login, we will automatically create an event for you, with ten session submissions!

Make sure you either accept sessions and inform speakers, and set times and rooms to sessions, using Schedule Builder.

Can somebody else do that for me?

Yes, you can give "developer" access for your event to your webmaster or developer. They will have access only to embed / API area of your event.

Open your event dashboard, click on "Team" tab and send an invite.

I have more questions!

Please contact support@sessionize.com and we'll be glad to help.

WordPress plugin

What do I need to use your WordPress plugin?

You'll need a WordPress site and access to its dashboard. WordPress plugin is just an easier way to embed.

You'll also need to create a embed endpoint. Don't worry, it's easy. Find "API / Embed" in the event menu and click it.

Choose "Styled Html" format, and make sure you have at least a few sessions accepted and scheduled, and their speakers informed. Save changes.

Where do I get the plugin?

You can download the plugin here. Save it on your computer.

How do I install it?

After downloading the plugin (see the previous question), go to your site's dashboard, find "Plugins" in the menu, and click "Add new". Then "Upload plugin" and choose the downloaded file from your computer.

Click "Install now".

Click "Activate Plugin".

How do I use it?

After installing the plugin, edit any page or post, and find the Sessionize.com button in the toolbar. When clicked, it will ask for Embed ID and View.

Find the ID of the embed endpoint created in the first step.

ID is the first column in the list. Copy it to the clipboard.

Paste it, and choose the view. Click OK.

The result will look like this. Feel free to save it and preview changes - the selected view will appear on the page!

You can repeat the process with multiple pages / posts on your web site.

May I just test it?

Yes, follow the instructions above and use the following ID l9c4tvg5.

API

What formats are available?

We offer read-only data in JSON and XML formats.

What data is available?

You can access sessions, speakers and rooms data for each event, and relation between them.

With sessions you can also have additional fields you've defined for your event (categories, tags, questions, files etc.).

With speakers you can get additional links (like Twitter profile, blog, company etc.).

Additional items for sessions and speakers are not enabled by default, you have to enable it for your endpoint.

Do I have to retrieve all data at once?

You may, but you don't have to. You can have all data, or data prepared for different views: table view, grid view, sessions list, speakers list and speaker wall. Click on any to preview.

Do I have to cache data locally?

Please do.

I have more questions!

Please contact support@sessionize.com and we'll be glad to help.

Troubleshooting

I don't see sessions or speakers.

Please check the "includes sessions" option. By default, this option shows only accepted sessions whose speakers have been informed of being accepted. If you don't want to inform speakers, you can switch to "accepted" mode.

I don't see rooms and times.

Please check the "schedule published" option on Schedule tab. When this option is turned off, session times and rooms are hidden.

I've made a change, but it doesn't show.

All embed and API request are being cached for up to five minutes. You can clear the cache manually at the bottom of the "Get Code" page.

Quick links