---
title: Sessions
slug: docs/sessions
createdAt: 2026-04-21T16:31:45.235Z
---

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

:::BlockQuote
POST /api/webhook/ingest/123e4567-e89b-12d3-a456-426614174000
Authorization: Bearer eyJhbGciOi...
Content-Type: application/json
Accept: application/json
:::

:::BlockQuote
\{
&#x20; "session": \{
&#x20;   "resource\_id": "acme/session/9001",
&#x20;   "organisation\_uid": "EXT-SESSION-42",
&#x20;   "program\_uid": "6ea0f651-2641-4e3d-9a93-0cd1f704cfb1",
&#x20;   "name": "Introduction to Cloud Architecture",
&#x20;   "description": "An introductory session covering core cloud architecture patterns.",
&#x20;   "start\_time": "2026-06-15T09:00:00+10:00",
&#x20;   "finish\_time": "2026-06-15T10:00:00+10:00",
&#x20;   "location\_resource\_id": "acme/location/301",
&#x20;   "active": true,
&#x20;   "restricted": false,
&#x20;   "skill\_level": "100",
&#x20;   "categories": \[7, 12],
&#x20;   "card\_link\_type": "external",
&#x20;   "card\_link\_url": "https\://example.com/session-details",
&#x20;   "card\_link\_label": "View Details"
&#x20; }
}
:::

### 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.
