Skip to main content
This page lists every field you can put in a Soundcheck import file: the JSON file that brings your clients, venues, gigs, crew and the rest into Soundcheck in one go. Older docs and the API call it UEF, short for Universal Event Format. This page covers version 2.0, the number in each file’s schema_version. How to read a row: Field is where the value goes in the file. events[].title means the title of each gig in the events list, and events[].shifts[].seats means the seats of each shift on each gig. A Required field must be there. Leave out anything else you don’t have. Every field on this page is Stable. While the version starts with 2., no field is removed, renamed or changed in a way that breaks a file that worked before; new fields only get added. See Stability and versioning. A field that isn’t on this page can’t be imported: check_import_file and the import reject it. This page is built from the same source as the format the get_import_format tool returns, and a test fails if they ever disagree. Every example is checked with check_import_file on each change, so you can copy one as a starting point.

Top of the file

These sit at the top of the file, beside the lists below. Every list is optional, but a file needs at least one record, and a key that isn’t on this page is rejected.

Team members (members[])

People to add to the organization’s team, with their roles and positions.

Example: team members

A team member with a role and two positions.

Clients (clients[])

Clients (customers) that projects and gigs are for. Give a record a ref (any short name, such as main-stage) so other records in the same file can point at it, and an external_id (its ID in your other system) so importing the file again updates that record instead of adding a copy.

Example: clients

A client with a ref, an external ID and a primary contact.

Venues (venues[])

Venues that gigs take place at. Give a record a ref (any short name, such as main-stage) so other records in the same file can point at it, and an external_id (its ID in your other system) so importing the file again updates that record instead of adding a copy.

Example: venues

A venue with its production details.

Inventory (inventory[])

Gear the organization owns.

Example: inventory

A piece of gear with its count and value.

Acts (acts[])

Performing acts that run-of-show items can name. Give a record a ref (any short name, such as main-stage) so other records in the same file can point at it, and an external_id (its ID in your other system) so importing the file again updates that record instead of adding a copy.

Example: acts

An outside act that a run-of-show cue can name by ref.

Songs (songs[])

The repertoire.

Example: songs

A song with its duration in seconds and tempo.

Setlists (setlists[])

Setlists and their sets.

Example: setlists

A setlist template with one set of two songs.

Projects (projects[])

Tours, festivals, residencies and other bodies of work that own gigs. A gig without a project gets its own one-gig project. Give a record a ref (any short name, such as main-stage) so other records in the same file can point at it, and an external_id (its ID in your other system) so importing the file again updates that record instead of adding a copy.

Example: projects

A tour that owns gigs, linked to its client by ref.

Gigs (events[])

Gigs, each with its days, run of show, shifts and crew. Give a record a ref (any short name, such as main-stage) so other records in the same file can point at it, and an external_id (its ID in your other system) so importing the file again updates that record instead of adding a copy. Each events[].pack_items[] needs at least one of name or external_id.

Example: gigs

A one-day gig with an inline venue, a run of show, a staffed shift, a gear line and a deposit.

Leads (leads[])

Booking inquiries.

Example: leads

A booking inquiry.