Developer Guide for Spreadsheet Endpoint

Intro

The Spreadsheet Endpoint makes agenda data available as an Excel, Open Document or CSV file at an endpoint.

To create an endpoint a new Spreadsheet publication needs to be configured by an event manager, this will generate a unique URL for the event.

If the event manager has asked you for answers to the ‘Webhook’ then review the ‘Webhook’ documentation below.

Requesting the data

To request the event data perform a GET to the URL you have been provided by the event manager. This URL is unique for each publication. The endpoint may require credentials using HTTP Basic Auth depending on the settings in the configuration.

You will receive 302 redirect with a temporary url for the location of the data. Note that the destination of this 302 will change for each request and will expire. You should begin your request with the initial url starting with http://api.lineup.ninja each time.

Refreshing the data

The event manager will make changes to their content over the course of time. To receive the changes you can either poll every 5 minutes, or integrate the webhook to receive an instant notification that new event data is ready.

If you are polling the event data be sure to schedule the removal of the polling after the event has completed.

When content is removed from an event, eg a speaker pulls out, you will not receive an explicit notification. Instead, because the document contains the full set of data for the event, you should treat that absence of a previously existing object as a request to delete that object.

Profile Photos / Company Logos

Profile Photos (aka headshots) and Company Logos are not included by default by can be added by the event manager.

They are available at these sizes.

• 128x128
• 256x256
• 512x512
• 1024x1024

To add the size that you want to the sheet perform the following actions

• Navigate to  Publish Agenda , click the name of the publication in the table at the top of the page.
• Click ‘Configure’.
• Expand out the sheet you want to modify
• Scroll down to the Speaker Profile Picture, and Speaker Company Logo options and toggle on the ones you want to include.

Company Logos are included with the original aspect ratio and scaled to fit the same sizes as the headshots.

Files

The event manager can choose to include additional links to files attached to speakers and sessions. To configure this

• Navigate to  Publish Agenda , click the name of the publication in the table at the top of the page.
• Click ‘Configure’.
• Expand out the sheet you want to modify
• Scroll down to the file type you wish to include and toggle it on.

The included links are unique to each publication for the event, if the event manager deletes the publication the links will cease to operate.

Webhook

If configured Lineup Ninja will call a webhook after a successful publish of the event. The webhook is called as a POST with this body:

{
    /**
     * The UUID of the event
     */
    eventId: string;
    /**
     * The name of the event
     */
    eventName: string;
    /**
     * The timestamp for the publication. You can use this to deduplicate calls to the webhook
     * It is in epoch time with milliseconds (A javascript timestamp)
     */
    publicationTimestamp: number;
    /**
     * The UUID for the integration. The customer may wish to configure multiple integrations per event,
     * for example to different staging and production events. this ID can uniquely identify them
     */
    integrationId: string;
}

To create the webhook ask the event manager to edit the configuration to set the value of ‘Webhook URL to call after publishing’ to your desired URL.

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.​​​​​