Configure

Create the integration

Follow these steps to get the integration initially configured.

  1. In your Lineup Ninja event, navigate to  Publish Agenda and then click the ‘Publish’ button under ‘JSON’. This will create a new publication.
  2. A screen will pop up where you can enter a username and password to secure the endpoint. You can also input the ‘Webhook URL’ you would like Lineup Ninja to call when the agenda is published. Save the configuration.
  3. Now click ‘Publish’ to publish the agenda to the URL shown on the screen.

Fetch the data

Perform a GET to the URL shown after publishing your event. If you have configured a Username and Password for the agenda you must provide these as HTTP Basic Auth on your request.

Files

The integration can be configured to include links to files attached to speakers, sessions, labels, locations, resources and tracks. You can choose to include all files, or just files of a particular type.

Note

If you include links to uploaded files in a JSON publication then the links are unique for that publication.

If you delete the JSON publication the links will stop working. This means you can revoke access to files that were previously shared be deleting the publication.

How can I filter the published content?

You can filter which Speakers and Sessions will be published based on a number of criteria. Some common use cases for filters are:

  • Preventing ‘Placeholder’ sessions from being published
  • Holding back a Speaker who is not yet ready to be announced
  • Excluding sessions scheduled during the ‘build up’ day for the event
  • Only publishing speakers who have confirmed their slot
  • Removing a particular location, or track from the published schedule
  • Anything you can think of using labels!

For Speakers you can filter in 3 ways

  • Choose which speakers are to be published based on their relationship to sessions
    • (If Speaker Confirmation is enabled): Publish speakers that have a confirmed session that is published and not filtered out.
    • Publish speakers that are speaking on any session that is published and not filtered out.
    • Publish all speakers
    • Publish no speakers
  • Apply more granular filters with labels
    • Only publish speakers with a particular label. For example you might want to use a ‘Content Reviewed’ label to flag speakers that have had their content reviewed.
    • Exclude speakers with a particular label. For example you might want to exclude a ‘Do not publish’ label to prevent publishing of speakers who are not yet ready to be published.

For Sessions you can filter in numerous ways

  • Choose which sessions are to be published based on their relationship to speakers
    • Publish All Scheduled Sessions. Publishes sessions regardless of whether they have confirmed speakers or not.
    • (If Speaker Confirmation is enabled): Publish sessions that have one confirmed speaker.
    • (If Speaker Confirmation is enabled): Publish sessions that have all their speakers confirmed.
    • Publish All Sessions (available on Lineup Ninja Agenda App only)
  • Apply filters with labels
    • Only publish sessions with a particular label. For example you might want to use a ‘Content Reviewed’ label to flag sessions that have had their content reviewed.
    • Exclude session with a particular label. For example you might want to exclude a ‘Placeholder’ label to prevent publishing of sessions which are not yet populated.
  • Filter by location
    • Only publish sessions in a particular location, or locations. This can be useful if you are publishing an agenda for just one or two locations.
    • Exclude sessions in a particular location, or locations. This can be useful if you have scheduled sessions in your Green Room or similar back stage location.
  • Filter by resource
    • Only publish sessions needing a particular resource. This could be useful if you are producing an agenda for a particular team that manages some resources.
    • Exclude sessions needing a particular resource.
  • Filter by Date
    • Only publish sessions in a date or dates. Useful if you are producing an agenda for a particular day.
    • You can exclude a date or dates from your publication. Useful if you have dates for build up and tear down in your agenda.
  • Filter by Track
    • Only publish sessions in a particular track or tracks. Useful if you are producing separate agenda for separate parts of your event
    • Exclude sessions on a particular track. Can be useful to block presenting of a track until a product launch has happened.

To configure filters:

  • Click ‘Publish Agenda’
  • Click on the name for your existing publication
  • Click ‘Configure’
  • Expand the ‘Filter Speakers’ and ‘Filter Sessions’ sections and configure the filters you need
  • Save and republish

How can I merge locations, tracks and roles when publishing?

When publishing you can merge content together. This enables you to publish a simpler agenda for your attendees than the one you are using to plan your event.

You can choose to merge these types of data:

  • Locations. Merging location A into location B will show all sessions in location A as taking place in location B. This can be useful if you have multiple locations configured for scheduling purposes that will be experienced by the attendee as a single location.
  • Tracks. Merging track A into track B will show all sessions in track A as being in track B. This can be useful if you have some tracks with only a small number of sessions and wish to present this sessions as being in a more populous track.
  • Roles. Merging role A into role B will show speakers with role A has having role B. This can be useful if you have a lot of roles internally that are not intended to be shown to attendees. You can merge them into a role with a name appropriate for your attendees.

When merging the location, track, or role that you are merging into does not have to have any sessions itself. So you can use this to show a different name to attendees than you are using internally. For example you could create a ‘Main Hall’ location, and merge ‘Building B - Hall A’ into that location so attendees see ‘Main Hall’ in their agenda.

How can I embargo content that is not yet ready for the public?

You can choose to embargo session titles and descriptions if you have content that should only be shown to the public after being announced in the event.

An embargo is applied by using labels to identify the sessions that should have an embargoed session title or description.

For example if you have a label ‘New Product Launch’, you can configure an embargo to hide the session title and description from sessions with that label. Following the launch of the product you can remove the embargo and republish the agenda.

If you embargo a session or description you can replace the original text with something to indicate that the session will be published later, for example ‘Super Secret Session’.

The speakers for a session will still be shown when it is embargo’ed. To exclude a session, including it’s speakers from being published then use ‘Session Filters’ rather than an ‘Embargo Content’.

To configure an embargo:

  • Click ‘Publish Agenda’
  • Click on the name for your existing publication
  • Click ‘Configure’
  • Expand the ‘Embargo Content’ sections and configure the embargo that you need
  • Save and republish

How can I publish automatically?

Warning

Consider your teams workflow as a team before enabling automatic publishing. When you enable automatic publishing there is a potential for the agenda to be published when you have content that is not ready for publication.

What is the schema for the document?

Please see this page


Next - Integrate Agenda


Still can’t find what you’re looking for? Email support@lineupninja.com and one of the team will get back to you as soon as possible.​​​​​