Submission JSON Endpoint

Warning

The JSON Endpoint is for integrating with third-party systems. If you just want to download your submission data, use a Submission JSON Report instead.

Lineup Ninja can publish your submission data to a JSON endpoint. The data is returned in a format designed to be read by a machine, so it is a good choice when sharing the data with a developer or integrating with another system.

How do I create a JSON Endpoint?

  1. Navigate to Submission Flows  >  Submission Reports and scroll down to ‘Report Publications’.
  2. Click ‘Create’ under ‘JSON’. This creates a new publication.
  3. 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.
    • Optionally enter a Webhook URL to call after publishing. Leave this blank if you are not using a webhook.
    • Choose whether to include or redact contact details (email and phone). These are included by default — see Contact details below.
  4. Click ‘Publish’ to publish the data to the URL shown on the screen.
  5. Copy the URL, username and password and give them to the developer or system that will fetch the endpoint.

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 submission data as JSON. 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.

Contact details

By default the endpoint includes contact details — email and phone. If you would rather not share them, set ‘Contact details (email and phone)’ to ‘Redact contact details’ in the configuration before publishing.

When contact details are redacted, submitter and reviewer email addresses are omitted and any answers to email or phone questions are blanked out, wherever they appear in the data.

Where can a developer find the schema?

Direct your developer to the developer documentation, which describes how to request the data, the full schema, the webhook payload, and how to interpret answers and intents.

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