Sessions
Use a Sessions-type ingest endpoint to create and update session records within an event. This enables third-party systems - such as content management systems or scheduling tools - to programmatically manage session data in Jomablue.
Typical use cases include:
- Syncing session schedules from an external agenda or content management system
- Updating session details (times, descriptions, locations) as they change upstream
- Populating session metadata such as categories, skill levels, and card content from external data
How It Works
Sessions ingest works the same way as People ingest: you send a JSON payload to the ingest endpoint, and Jomablue maps the fields based on the endpoint's configured mapping rules. The endpoint, authentication, rate limits, and request format are identical - the only difference is that the endpoint is configured as a Session type, and the mapped fields correspond to session attributes rather than person attributes.
Existing sessions can be matched using either a resource_id or organisation_uid to update records rather than create duplicates.
Mapped Fields
The following fields are available for mapping within a Session ingest endpoint
Field | Type | Notes |
|---|---|---|
resource_id | String | Formatted identifiers (e.g. acme/session/123) generate by Jomablue. Used for matching existing sessions. |
organisation_uid | String | An external unique identifier for the session. |
program_uid | String | Associates the session with a program by the program's UID (the same program_uid values returned by the Event Discovery API). |
code | String | A human friendly/publicly displayed session identifier |
name | String | The session name/title. |
description | String | Session description text. |
start_time | String | MySQL datetime (Y-m-d H:i:s, UTC) or ISO 8601 strings with offsets. |
finish_time | String | MySQL datetime (Y-m-d H:i:s, UTC) or ISO 8601 strings with offsets. |
location_resource_id | String | Formatted identifiers (e.g. acme/location/123) or plain integers referencing an existing location. |
location_organisation_uid | String | References the session's location by the location's external organisation UID (an alternative to location_resource_id). Requires a companion location name to be mapped - if no location matches the supplied UID, one is created using that name. |
active | Boolean | Whether the session is active. Truthy/falsy values are automatically normalised. |
restricted | Boolean | Whether the session is restricted. Truthy/falsy values are automatically normalised. |
restricted_allow_override | Boolean | Whether the restriction can be overridden. Truthy/falsy values are automatically normalised. |
visible_in_api | Boolean | Whether the session is visible via public consumable APIs. Truthy/falsy values are automatically normalised. |
allow_survey | Boolean | Whether the session allows survey responses. Truthy/falsy values are automatically normalised. |
skill_level | String | The skill level associated with the session. |
sort_order | Integer | Controls the display order of sessions. |
entry_buffer | Integer | Buffer time (in minutes) before the session start. |
related_content_buffer | Integer | Buffer time (in minutes) for related content display. |
categories | String / Array | Pipe-separated string of record IDs or array of integers |
traits | String / Array | Pipe-separated string of record IDs |
card_content | String | Content displayed on the session card. |
card_link_label | String | Label for the session card link. |
card_link_type | String | Validated against CardLinkType enum; accepts "internal" or "external". |
card_link_url | String | URL for the session card link. |
card_allow_rating | Boolean | Whether ratings are enabled on the session card. |
card_allow_comment | Boolean | Whether comments are enabled on the session card. |
card_rating_message | String | Custom message displayed for session ratings. |
email_content_id | Integer | Record ID of the associated email content. |
sms_content_id | Integer | Record ID of the associated SMS content. |
related_email_content_id | Integer | Record ID of related email content. |
related_sms_content_id | Integer | Record ID of related SMS content. |
related_card_content_id | Integer | Record ID of related card content. |
eventapp_promo_text | String | Promotional text displayed in the event app. |
eventapp_promo_logo | String | Promotional logo for the event app. |
eventapp_background | String | JSON object or JSON-encoded string of CSS properties. Invalid values are ignored. |
Example Request
Considerations
- The same general considerations as People ingest apply: requests are processed asynchronously, a 200 Accepted means queued (not yet processed), and event ordering is not guaranteed.
- Existing sessions are matched by resource_id or organisation_uid. If neither is provided or matched, a new session is created.
- The organisation_uid can be updated via ingest when a session is matched by resource_id
- Duplicate organisation_uid values are detected and logged as warnings.
- When mapping location_organisation_uid, if no existing location matches the supplied organisation UID, Jomablue creates a new location using the mapped location name.
- Speaker and Track assignments are not currently available via session ingest.