With the Yesplan integration you can easily publish events from Yesplan and synchronize event data like sales and scanning numbers. In this article we will guide you through the following items:
- Set up Yesplan integration in Paylogic
- Set up integration in Yesplan
- Publish an event from Yesplan to Paylogic
- Extra information

Before you can start on setting up the Yesplan integration, Yesplan needs to be activated for your account. Please contact your Client Success Manager to help you activate it.
1. Set up Yesplan integration in Paylogic
- Go to the Paylogic backoffice. Click ‘Merchant’ in the menu, then click ‘Integrations’ and then click ‘Yesplan’.
- You land on the Yesplan integrations page. Click ‘Create API token’.
- Your API credentials now have been created and are displayed. Copy and store the secret and Client ID somewhere safe. You need both in later steps.
- Click ‘Continue’.
- Now that you have created the API credentials, you are also able to add template events. A template event is needed for the integration. This template event will be used as the base for your new event.
- Click ‘Add template events’.
- A modal opens where you can select all the events that you want to be able to use as a template to create events from Yesplan. After you have selected the template events, click ‘Add selected events’.
- The selected events are now displayed as template events and you’ve completed this part of the setup.
2. Set up integration in Yesplan
2.1 Add Group
- Go to your Yesplan application and log in.
- Hover over your account name in the bottom menu and select ‘System settings’.
- Click ‘Events’ in the top row of menu items.
- Click ‘+ Add a Group’.
- Double click on ‘New’ and replace ‘New’ with ‘Paylogic’. Confirm with ‘OK’.
- Now click ‘Open’ on the Paylogic group.
- Click ‘+ Add a Field’.
- Select ‘Publication trigger’ as type and write ‘Publish on Paylogic’ as label’. Now click ‘Add’.
- Click ‘+ Add a Field’ again.
- Select ‘Dropdown’ as type and write ‘Event Template’ as label. Now click ‘Add’.
- Click ‘+ Add a Field’ again.
- Select ‘Date and time input’ as type and write ‘Sale Start’ as label. Now click ‘Add’.
- Click ‘+ Add a Field’ again.
- Select ‘Date and time input’ as type and write ‘Sale End’ as label. Now click ‘Add’.
- Click ‘Add’ under ‘Where or When to Show’ in the table.
- Select ‘Info’
- You now see ‘Info’ in the ‘Inspector Tabs’ column for all your fields.
- Lastly double click on ‘Description’ in the ‘Event Template’ row. Add the following sentence:
- “The template event to be used when first publishing this event on Paylogic. Note: this option cannot be changed after publishing for the first time.”
- Confirm with ‘OK’.
2.2 Add Integration
- Go to your Yesplan application and log in.
- Hover over your account name in the bottom menu and select ‘System settings’.
- Click ‘Integrations’ in the top row of menu items.
- Now click the ‘+’ icon. Enter ‘Paylogic’ as name and click ‘Add’.
- Select ‘Generic ticketing’ as ‘Integration Type’.
- Now a whole set of new options is opened. Configure the following:
- Authentication Type: OAuth 2.0
- Grant Type -> Client Credentials
- URL of resources server: https://partner.paylogic.com/yesplan
- URL of authorization server: https://partner.paylogic.com/yesplan/token
- Client ID: Here you fill in the Client ID you generated in Paylogic (step 1.3)
- Client Secret: Here you fill in the secret you generated in Paylogic (step 1.3)
- Now click ‘Verify’ in the ‘Connection to Ticketing System field. You should now see ‘Verified’ next to the button.
- In the ‘Mappings’ setting click ‘Click to update’. You should now see ‘Updated’ next to the button.
- Uncheck all the checkboxes under ‘Protocol Support’
- Under Actions -> Publish -> select the trigger that you created in the events Group (See 2.1.8).
- In the ‘Mappings’ setting click ‘Click to update’ again. You should now see ‘Updated’ next to the button.
- In the ‘Publishing Events – Data Flow from Yesplan to Ticketing System’ section add the following fields:
- event_uid
- Select ‘paylogic_template’ in the dropdown as ‘Field in Yesplan’.
- Select ‘template_events’ in the dropdown as ‘Mapping.
- Click ‘Add’.
- sale_start
- Select ‘paylogic_salestart’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
- sale_end
- Select ‘paylogic_saleend’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
- subtitle
- This field is optional, but you can use this to also prefill the subtitle in the Paylogic event.
- You can map this for example to ‘production_subtitle’
- project_code
- This field is also optional, but can be used to prefill the project code field in a Paylogic event. This can be useful to store an internal ID, that you are using for an event in Yesplan, also in Paylogic.
- Map to the corresponding data field in Yesplan.
- It is also possible to synchronize data from Paylogic to Yesplan. If you want this, you can set up the fields like below or make your selection on which fields you want to make use of. In the ‘Remote Data – Data Flow from Ticketing System to Yesplan’ section you can add the following fields:
- total_available_tickets
- Select ‘ticketing_available_tickets’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
- total_capacity
- Select ‘ticketing_capacity’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
- total_not_scanned_tickets
- Select ‘ticketing_tickets_not_scanned’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
- total_scanned_tickets
- Select ‘ticketing_tickets_scanned’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
- total_sold_tickets
- Select ‘ticketing_sold_tickets_paid’ in the dropdown as ‘Field in Yesplan’.
- Click ‘Add’.
3. Publish an event from Yesplan to Paylogic
Now that you have set up the integration, you are able publish your event from Yesplan to Paylogic. Follow these steps to do so:
- Go to your Yesplan application and log in.
- Select ‘Events’ in the bottom menu.
- Open the event you want to publish to Paylogic.
- Search for the ‘Paylogic’ section.
- Click ‘Show all’.
- In the ‘Event Template’ field you can select the template event you want to use as base for your new event.
- Good to know is that all settings of the template event will be copied to the new event, except for the following fields. These fields will be filled in Paylogic with data coming from your Yesplan event:
- Event Title
- Event subtitle (optional)
- Event date/time start
- Event date/time end
- Location
- Sale date/time start
- Sale date/time end
- Project code (optional)
- Fill in the dates and times for the ‘Sale Start’ and ‘Sale End’ fields
- Now click on ‘Publish Event’ in the ‘Publish on Paylogic’ field.
- You should get confirmation that the action was successful.
- The event has now been created in Paylogic! Go to the Paylogic backoffice to check the event.
- When you want to add a new template event and have added it in the Paylogic backoffice, you need to update the mappings in Yesplan as well. You can do this in System settings > Integrations > Paylogic
- Total sold tickets that are synchronized from Paylogic to Yesplan may contain guestlist tickets, discounted tickets, etc, this may not fully reflect what is expected by “ticketing_sold_tickets_paid”.
- The data fields are populated each time you open an event, clicking on update does not work if the latest update was done recently, this is a Yesplan limitation.
- The publication from Yesplan to Paylogic can only be done a single time. Further changes in Yesplan won’t be pushed to the Paylogic event once it has been created. Same goes for changes made on the Paylogic event, those are not pushed to Yesplan.
- The location is ignored to prevent creating many duplicated locations, the location from the template event is being used when a new event is created.