Skip to main content

Guide: External Integrations

Follow the steps below to create an Integration with an external API

Create the Event

  1. Go the Events page and create a new Event

  2. You only need to enter the details for the Info page to begin with - prices and Performances will be generated once the Integration is created (see below) so no need to create these once the Info page has been submitted

  3. Add the External ID (provided by the external system) to the Extras section on the right of the Info page.

    NOTES:

    • Nliven - they normally provide an alphabetical ID as opposed to a numerical one, e.g. GIEOLT

    • Audience View - the External Event ID needs to be the Event name and matched exactly to what it is in AV.


Create an External Integration

  1. Either to the Tools page on the left hand side and click External Integrations

  2. Or go to the Settings page on your Event and click External Integration


Enter Details for Integration

  1. Name - for internal use

  2. Description

  3. Event - if creating via the Tools page. This field can't be updated once the integration is created

  4. External Event ID - the ID of this Event in the external system. Provided by the external system


Configure Pricing

  1. Tax Rate - select either the Default Tax Rate or a Custom Tax Rate which you can create on the Settings page

  2. Base Price Adjuster - optional. This is an Inside Adjuster that will be applied to all prices before other Adjusters, changing the price the other Adjusters will be based on

  3. Inside Adjusters - select the Adjusters that will be automatically applied to all prices on the external Event

  4. Outside Adjusters - see above

NOTES:

  • For External Events, you only need to add Adjusters on the External Integration page. They will then pull through to the Price Table once it has synced.

  • For Spektrix and Nliven Events, you will only be able to Adjusters at this point, not on the Price Table. It is not currently possible to amend Adjusters once they're on the Price Table for Spektrix Events.

  • For Nliven Events, a lot of prices come through as Discount prices, so Adjusters will often only pull through in the Price Table when on Discount Mode.


Configure Integration Type

Nliven

NOTE - you will need the following information from the external system or the venue you'll be selling for.

  1. Select Nliven from the dropdown

  2. Enter API Key - provided by the venue

  3. API URL

  4. Prefix - this will be attached to the front of the Transaction Reference for orders using the Nliven Integration

  5. Delivery Method - optional, the ID provided by Nliven

  6. Allow Email Sharing - select to enable the Customer's email to be shared with Nliven

  7. Enable Ticket Import - select to enable Nliven Barcodes to be imported as external Barcodes

  8. Enable Seat Type Sync - select to enable Nliven Seat Types to be synced into Line-Up

  9. Click Create


Audience View

  1. Select Audience View from the dropdown

  2. Enter API Key - provided by Audience View or the AV venue

  3. API URL

  4. Prefix - will be used when creating resources, e.g. Seat Types

  5. User ID

  6. Password

  7. Promo Code

  8. Delivery Method ID - the ID provided by Audience View

  9. Agent ID

  10. Payment ID

  11. Allow Email Sharing - select to enable the customer's email to be shared with Audience View

  12. Enable Ticket Import - select to enable Audience View barcodes to be imported as external barcodes

  13. Enable Seat Type Sync - select to enable Audience View Seat Types to be synced into Line-Up

  14. Click Create


Spektrix

  1. Select Spektrix from the dropdown

  2. Client Name - your Spektrix client name. This can be found in the URL when you access the API Key, e.g. yourclient from https://system.spektrix.com/yourclient -

  3. API Username - the username for authenticating with the Spektrix API

  4. API Key - the secret key for authenticating with the Spektrix API

  5. Prefix - this will be attached to the front of the Transaction Reference for orders using the Spektrix Integration

  6. API URL - the URL to access the Spektrix API, which is https://system.spektrix.com. This is the same for every Spektrix integration

  7. Prefix - customisable. This will be attached to the Transaction Reference for orders using this Integration

  8. Allow Email Sharing - select to enable the customer's email to be shared with Spektrix

  9. Enable Ticket Import - select to enable Spektrix barcodes to be imported as external barcodes

  10. Enable Seat Type Sync - NOTE, this is not yet possible with the Spektrix integration.

  11. Click Create


Create Venue Plan

  1. On the Venues page, click the Venue Plans tab

  2. Click New Venue Plan and enter details

  3. Use the Builder to build your Venue Plan

NOTES:

  • You'll need to match how these systems structure their Venue Plans, i.e. how the hierarchy is created - Areas, Sections, Rows, Seats, etc.

  • You also need to ensure that Section labels match exactly what is on the external system (you can name Area labels differently if you wish). NOTE - this can be as granular as ensuring any special characters, e.g. apostrophes, match to what you receive from the system.

  • If you are integrating with Spektrix, please note that Spektrix only have Sections, not Areas.

    • When building the Venue Plan on Line-Up, you'll need an Area first in order to build your Section, but it is the Sections that you'll need to match with Spektrix.


Manage Synced Items

  1. Once the Integration is created for the Event, the Performances and Price Tables will be automatically generated

  2. On the Performances page, add Channel access

  3. On your Price Table(s), add the Channels to your Variants

  4. Create a Price Profile on the Event - but do not add Bands to seats.
    ​NOTE - you can only do this once the Venue Plan is created

  5. Add Price Profile to Performances.
    The proactive syncing will kick in once the Price Profiles get added.

  6. If these have been synced, add Channel access to their respective pages:


Sync Changes

  1. If changes are made to prices or Performances, you can run a Sync to pull these changes by clicking the Sync Now button

  2. Once the Sync Now button is clicked, the synchronisation will be queued and the changes should pull through within a couple of minutes. You will not be able to click this button again for five minutes

    NOTE - this button will do an Event-level Sync, i.e. creating new Performances, changes in pricing, etc.

    It won't do a Performance-level Sync, i.e changes to capacities or Price Bands, or Venue Plan Sync.

    However, we will still run a Sync in the background every 3 hours that will cover any of these changes.


Connect Event to Online Booking Flow

NOTE - once your Event has fully synced then you will be able to view it in Box Office. However, if you are using the Line-Up Online Booking Flow, we will need to connect the integrated Event on the back-end in order for the correct inventory to show online.

  1. Once you have set your External Event up on Line-Up, send Support the Event ID and your planned on-sale date

  2. We will then connect the Event to the Online Booking Flow and you can start selling via your Line-Up domain

Did this answer your question?