Submission Spreadsheet Endpoint
Warning
The Spreadsheet Endpoint is for integrating with third-party systems. If you just want to download a spreadsheet, use a Submission Spreadsheet Report instead.
Lineup Ninja can publish your submission data to an endpoint that returns a spreadsheet. Your developer can fetch this endpoint to retrieve the submission data for your event and integrate it with your systems.
How do I create a Spreadsheet Endpoint?
- Navigate to > and scroll down to ‘Report Publications’.
- Click ‘Create’ under the spreadsheet format you want - either Excel, ODS or CSV. This creates a new publication.
- A screen will pop up where you can configure the endpoint:
- Enter a username and password to secure the endpoint. The endpoint is protected with HTTP Basic Auth, so a system can only fetch it with these credentials.
- Choose which columns are included in each sheet, or leave the default configuration. See ‘What data is contained in the spreadsheet?’ below.
- Optionally enter a Webhook URL to call after publishing. Leave this blank if you are not using a webhook.
- Click ‘Publish’ to publish the data to the URL shown on the screen.
- Copy the URL, username and password and give them to the developer or system that will fetch the endpoint.
What data is contained in the spreadsheet?
The spreadsheet contains sheets for your submissions, speakers and reviews. You can configure which columns are shown in each sheet, or use the default configuration. The columns work the same way as the Submission Spreadsheet Report - see that page for a full description of the available sheets and columns.
How do I secure the endpoint?
The endpoint is protected with HTTP Basic Auth using the username and password you set when you created it. Anyone fetching the URL must supply those credentials. You can change the username and password at any time from the configuration screen.
How can I publish automatically?
Warning
Consider your team’s workflow before enabling automatic publishing. When you enable automatic publishing there is a potential for data to be published before it is ready.
To schedule publishing scroll down to the ‘Scheduled Publishing’ part of the configuration.
You can then choose whether to publish once per hour, or once per day. If you choose to publish each day the publication will occur around 3am in the timezone of your event.
If you do not enable scheduled publishing, the endpoint is updated only when you click ‘Publish’. The endpoint always returns the data as it was at the most recent publication.
How does a consumer fetch the endpoint?
The system fetching the endpoint makes an HTTP GET request to the URL shown on the configuration screen, supplying the username and password as HTTP Basic Auth. The response is the spreadsheet file in the format you chose. The URL stays the same across publications, so a consumer can fetch it on a schedule to pick up your latest published data.
If you set a webhook URL, Lineup Ninja calls it each time the data is published, so the consumer can fetch the endpoint as soon as new data is available rather than polling.
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.