Set up Urban Sports Club

Urban Sports Club (USC) lets its members book into your classes. Once it's connected, your chosen classes appear on USC, and the bookings arrive in CodexFit like any other booking.

This takes more setup than most integrations, because you need to tell CodexFit which of your locations and class types match which ones on USC. Have your USC details to hand before you begin.

Follow along

This step-by-step guide shows you how to add and set up the integration. The written steps below cover everything, including matching your business to USC.

Before you start

• Check your permissions. Your admin account needs the Manage configuration permission. If you can't see Integrations in Business Settings, ask the owner of your account to add it for you.
• Get these details from USC. Ask your USC account manager, or look in the USC partner portal:
  • Client ID and Client Secret
  • Provider ID for your business (one for each organisation, if you have more than one)
  • Location ID for each of your studio locations
  • Organisation handle: in the USC partner portal, look at the web address. The handle is the part that comes after /provider/.

Step 1: Create a credit type for USC visits

A credit type is how CodexFit records a visit that was paid for outside your own memberships. Giving USC its own credit type keeps its revenue separate in your reports.

1. Go to Business Settings → Credit Types.
2. Create a new credit type and name it something clear, such as "USC visit".

Want USC to show as its own payment method in your reports? Payment methods can't be added by studios, so contact CodexFit support and ask us to create a "USC" payment method. If you don't need this, you can use an existing one.

Step 2: Add and set up the integration

1. Go to Business Settings → Integrations and click Add integration.
2. Find Urban Sports Club and install it. You'll land on the USC settings page.
3. Fill in these fields:
   • Client ID and Client Secret: copy these from USC.
   • Shared Secret: click Generate key. This is a password that lets USC and CodexFit trust each other's messages. You don't need to copy it or send it anywhere yourself, because we'll pass it to USC for you in Step 3.
   • Organisation Handle: the handle from your USC partner portal address (see "Before you start"). It's only used to create links from your CodexFit classes to the USC portal.
   • Credit Type to generate for bookings: choose the "USC visit" credit type from Step 1. You must choose one here, so don't leave it blank.
   • Payment Method to log when generating credits: choose the payment method these visits should be recorded under.
   • Credit Value: what one USC visit is worth to you, including tax. This is the amount that shows as USC revenue in your reports.
   • Credit Tax Value: the part of that amount that is tax.
   • Secondary USC Environment: leave this blank.
4. Click Save.
5. Click Test. CodexFit checks that USC accepts your Client ID and Client Secret. If it fails, check you copied both exactly, with no extra spaces.
6. Click Enable.

Step 3: Ask us to finish the connection with USC

USC needs your shared secret, and the addresses it should send bookings to. We set this up with USC for you.

Contact CodexFit support once you've enabled the integration, and let us know it's ready. You don't need to do anything else for this step.

Step 4: Match your business to USC

Now tell CodexFit how things on your side match things on USC.

Your organisation

1. Go to Business Settings → Organisations and edit your organisation.
2. Open the Urban Sports Club tab.
3. Enter your USC Provider ID.

Your locations

1. Go to Business Settings → Locations and edit each location.
2. Open the Urban Sports Club tab.
3. Enter the Urban Sports Club Location ID.

Your event types

1. Go to Business Settings → Event Types.
2. Edit each event type you want to offer on USC and open its Urban Sports Club tab.
3. Choose a USC Category.

Event types without a category aren't sent to USC.

Your classes

1. Go to Events and open each class you want on USC.
2. Add the "USC visit" credit type to its accepted credit types.

Instructors: you don't need to set them up. CodexFit adds each instructor to USC the first time one of their classes is sent. After that, their USC ID appears on their Urban Sports Club tab.

Step 5 (optional): Limit how many spaces USC can sell

By default, USC can book every free space in a class. If you'd like to keep some spaces for your own members, you can set a maximum.

1. Go to Events and select the classes you want to limit.
2. Choose the bulk action Update Event Properties.
3. Set USC Capacity Override to the most spaces USC may sell.

When does a class go on USC?

A class is only sent to USC when all of these are true:

• it's visible to customers, in the future, and starts within the next 2 weeks
• it accepts the USC credit type
• its event type has a USC category
• its location has a USC Location ID, and your organisation has a USC Provider ID

What happens next

• New classes are sent to USC straight away.
• Every night, CodexFit does a full refresh and adds classes as they come into the 2-week window.
• USC bookings show up in CodexFit as normal bookings. CodexFit automatically creates a "USC visit" credit to pay for each one.

Good to know: once a class is on USC, you can't change its event type, studio, start time or cancellation period in CodexFit. If you need to change one of these, contact CodexFit support.

Check or fix a single class

Open a class from Events and go to its Urban Sports Club tab. There you can:

• see whether the class is on USC
• see a list of anything that's stopping it from syncing
• click Force Add to USC to send it now
• click Force Remove from USC to take it off

My class isn't showing on USC

Open the class and check the list on its Urban Sports Club tab first. It tells you what's missing. If it's blank, check the points in "When does a class go on USC?" above.

Still stuck? Contact CodexFit support and tell us the class name and date.