API and Connectors
Jomablue can connect to external systems to facilitate the programmatic data flow of registration data, interactions, engagement scoring, and more.
There are three methods of access data in Jomablue:
- Public API
- Push API
- Jomablue-built connector or Jomablue Data warehouse connector
Documentation for these APIs can be found here: https://apidocs.jomablue.com/docs
Public API
The Public API is available to all enterprise subscribers and focuses on querying people data from Jomablue or bulk adding people to the platform.
You would use this API if you want to build your own functionalities in BI tools or extend the functionality of your existing systems.
Example
If you are a service provider of a BI tool and would like to chart data event attendees, you could make requests to the Jomablue Public API to determine the segments of people registered (e.g., by Country, Business Type, or Employee Counts).
Alternatively, if you have an internal or custom-built registration system, you can programmatically pass registered people to Jomablue for a Jomablue Experience.
When to Use it
Use the Public API when you are building your own extensions to your current products and want to query or push people data to Jomablue.
Considerations
- Available out of the box for enterprise subscription customers
- If you don't see what you need, it's extensible upon request (may incur a fee)
- Not all interaction data is available through the API
Resources
Jomablue Push API (Most Popular)
Jomablue can publish real-time data feeds via AWS SNS as people are added, edited, and checked into events, sessions and vendors. The streamed data is JSON structured, allowing for filtering and routing of messages to various endpoints (e.g., HTTP endpoints, SQS, etc.).
Data is available from Jomablue as it happens, including information related to the event and its settings, attendees and their checked-in statuses, interactions with Vendors, and engagement during sessions. The sessions data includes inferred sessions when it is enabled.
If you want real-time dashboards within your organisation to display event registration data and insights into the segmentation of attendees, you could subscribe to Jomablue's SNS topics to receive real-time messages about the data being added, edited or updated in Jomablue.
When to Use it
Use the Push API when a push paradigm to a lead ingest system is your common workflow, and you have the ability to receive streaming data from an SNS topic.
Considerations
- Available out of the box for enterprise subscription customers
- Automated test endpoints are included to build into your production workflows
- Not all interaction data is available through the API
- Jomablue owns the topic and provides you with subscription permission
Granular Controls for Push API Enablement
Administrators can enable or disable data streaming per event and per data resource type, allowing fine-grained control over what data is delivered. This ensures cleaner automation and reduces unnecessary data noise.
Examples
- Enable People data for a single event
- Stream Vendor Leads and Session Attendance for another
- Disable entirely for archived or inactive events
Integration Test API
To support testing and validation, the Integration Test API allows technical teams to simulate data streams without triggering real event activity. This ensures your integration is functioning correctly before an event goes live.
When to Use it
Use the Integration Test API during staging, development, or troubleshooting phases to ensure your Push API integration is functioning correctly before the event.
Resources
Person Export API
For scheduled or post-event reporting, Jomablue provides programmatic access to export data for reporting or archiving through the Person Export API.
This API allows you to trigger and retrieve the Person Export directly from Jomablue, without needing to log in to the portal.
Key Features
- Supports customisation for columns and filters (matching portal options)
- Exports complete people data for event reporting or archiving
- Responds with file retrieval links upon completion
Example
You can schedule an automated post-event export job that calls the Person Export API, retrieves the CSV, and stores it in your internal data warehouse or cloud environment.
When to Use it
Ideal for technical teams who want to integrate Jomablue exports into automated data pipelines or BI workflows.
Ingest API: Managing Registrations
The Ingest API allows external systems to synchronise registration statuses, including cancelling or reversing a cancellation of a person, directly within Jomablue.
Example
If a registrant cancels through your external registration platform, the Ingest API automatically updates their Jomablue record to reflect that status, and restores it if they re-register later.
When to Use it
Use the Ingest API when you need to keep registration states synchronised between multiple systems or automate participant lifecycle management.
Jomablue Connector
The Jomablue connector is built and maintained by Jomablue and operates between Jomablue and external systems (e.g., Salesforce, Marketo). It is responsible for fetching, transforming, updating, and batching data between the two systems.
Example
If you use Salesforce internally and want Jomablue to contribute data to Salesforce without concerns about disparate data, Jomablue can create a connector that pushes new registration data to Salesforce along with real-time interaction data from events. The connector is configured to transform data to be meaningful for your Salesforce users and also supports batching to ensure that Salesforce API limits are not exceeded.
When to Use it
Use the Jomablue connector when you already have CRM and internal data models defined. In addition, if data needs to move frequently between systems and requires transformation during the process to comply with business rules or rate limits imposed by external systems (e.g., Transformation of date formats), this connector is ideal.
Note: Use this when connecting Jomablue to Salesforce, Dynamics365, Marketo, Marketing Cloud etc.
Considerations
- The most flexible option for programmatically connecting two systems
- Typically built within 3-6 weeks after requirement gathering
- Jomablue can offer real-time data pushes, however, this can be cost-prohibitive due to some CRM's API pricing structure. Therefore, minute-by-minute batching is a viable alternative within a Jomablue Connector.
- The connector can be considered an ETL solution between Jomablue and other systems
Jomablue Warehouse Connector
A data warehouse is a data management system designed to enable and support business intelligent data from various sources. The Data Warehouse Connector is a configurable tool that securely extracts custom datasets from Jomablue Instances and produces CSV files on an SFTP server or Amazon S3 bucket. You can customise the queries and frequency of file generation by requesting the change to the Jomablue Project Team.
Important features
- Customisable Data Queries - Each data query is customisable and is developed specifically for the use case
- Customisable Intervals - Set intervals from minutes, hours, to days or how often the queries run
- Production of Multiple File - Multiple files can be produced at each interval, which is generally preferred as we extract relational data.
- Customisable CSV file names - This includes date/time stamps and timezone offsets
- Support - SFTP supports certificate or Username/Password workflows.
- Automatic purging - Files generated are purged automatically from the SFTP server every 24 hours
- Queries retrieve updated data - Updated data is the data that has been updated since the last files were generated
- CSV data - It does not need to be 'raw' data, it could be as simple as counting the number of people in each category and placing that in a CSV
- Flexibility to choose between Amazon S3 and STFP - You can access data from Amazon S3 buckets instead of SFTP. AWS Credentials are provided to the customer for direct bucket access. Some systems like Tableau can connect directly to buckets.
- SMS notification for errors - SMS notifications are triggered for errors. This is triggered once and not for every invocation. These SMS notifications are sent automatically to Jomablue only, and act as an alert system that notifies Jomablue in case of any data extraction issue.
Limitations
- Column order and naming convention are limited in the CSV file
- Complex pivot table exports are currently unavailable in Jomablue. A workaround is that multiple
- CSVs are exported to another system to ingest them and do complex pivots.
- Jomablue does not transform data. For example, changing date/time formats or removing "empty" or "null" values from the data.
Note: This requires paid subscription. Should you wish to find out more, please contact your Jomablue Project/Account Manager.
Example
You have a data warehouse to archive vast amounts of data from your CRM or other internal systems and would like to add Jomablue data to that. Alternatively, you use a CRM or marketing tool that can fetch data from an S3 bucket or SFTP endpoints and can set it up to consume new files added to the cloud location.
When to Use it
Use a Jomablue warehouse connector when you have systems that are able to consume new files added to a cloud location. They could be Data Warehouses, CRMs, marketing tools or even some BI products such as Tableau.
Note: Use this when wanting to export data from Jomablue to Marketing Cloud, Snowflake or even Tableau.
Considerations
- Typically configured in 2-4 days
- Flexible data querying intervals from months, days and down to minutes
- Call back URLs to trigger instant data retrievals between polls
- Limited in data transformation, generally 'raw' data is provided with no additional insights
- The volume of data can easily reach millions of rows
- The exported format is CSV
