People
The People endpoint sends People out of your event: their identifiers, contact details, Custom Fields, Categories, and Program membership. Its endpoint is served at /updates/api/{endpoint-uuid}/event-people.
How it works
The template is the shape of the payload you want out. Each key is yours to name; the merge tag on the right supplies the value for each Person at send time. Two keys carry JSON values rather than text, so their tags sit without quotes: custom_fields and categories. Everything else is plain text and stays quoted.
cancelled and checked_in use the <<TAG|true:true,false:false>> form. They render as the strings "true" and "false".
Custom Fields and Categories can each be sent two ways, and you can use both at once:
- The whole set. custom_fields and categories return every one, as a JSON value.
- One named field of your own. <<CUSTOM_FIELD|key:...>> and <<HAS_CATEGORY|id:...>> each return a single value as plain text, so you can promote the one field your system cares about to a top-level key. The example below does this with dietary_requirements and is_speaker.
The two single-field tags read different things. <<CUSTOM_FIELD|key:...>> returns the value stored against that key, or an empty string when the Person has no value for it. <<HAS_CATEGORY|id:...>> returns a boolean - it reports whether the Category is applied, using the two strings you set with true: and false:. Set both of those options every time: without them the tag falls back to a raw boolean, which renders as "1" and "" rather than anything readable. Both tags return text, so is_speaker below is the string "no", not false.
Single-field tags need the Custom Field key or Category ID written into the template, so they are specific to your event. Change the identifier in the examples below to your own before using them. Category IDs in particular are specific to your Jomablue instance.
Sample mapping
Sample output
One rendered Person from the array the endpoint returns:
dietary_requirements repeats the dietary value out of custom_fields, and is_speaker reports the same Category 2 that appears in categories. This is to illustrate how each approach works - typically you would only use one approach (although using both is also allowed).
Field reference
Key | Merge tag | Emits |
|---|---|---|
event_id | <<EVENT_ID>> | Text. The event's resource ID. |
resource_id | <<RESOURCE_ID>> | Text. The Person's resource ID. |
organisation_uid | <<ORGANISATION_UID>> | Text. Your own identifier for the Person. |
first_name | <<FIRST_NAME>> | Text. |
last_name | <<LAST_NAME>> | Text. |
<<EMAIL>> | Text. | |
phone | <<MOBILE>> | Text. Mobile number. |
company | <<COMPANY>> | Text. |
job_title | <<JOB_TITLE>> | Text. |
cancelled | <<CANCELLED|...>> | Text "true" or "false". |
checked_in | <<BADGE_PRINTED|...>> | Text "true" or "false". |
import_type | <<IMPORT_TYPE>> | Text. How the Person entered the event. |
updated_at | <<UPDATED_AT>> | Text. ISO 8601 timestamp. |
created_at | <<CREATED_AT>> | Text. ISO 8601 timestamp. |
custom_fields | <<CUSTOM_FIELDS_LIST|format:json>> | JSON object of the Person's Custom Fields. Unquoted in the template. |
dietary_requirements | <<CUSTOM_FIELD|key:dietary>> | Text. One named Custom Field. Empty string if the Person has no value for that key. |
categories | <<CATEGORIES_LIST|...>> | JSON array of the event's Categories, each with an applied / not_applied status. Unquoted in the template. |
is_speaker | <<HAS_CATEGORY|id:2,true:yes,false:no>> | Text. Whether one named Category is applied. The true and false options set the two strings returned. |
The key names dietary_requirements and is_speaker are examples. Name them whatever suits your system.
Programs
Programs group People across an event, and each membership carries its own identifier and status. Program membership is sent the same two ways as Custom Fields and Categories: the whole set as a JSON array, or one named Program as flat text.
The whole set
Add a programs key. The tag returns a JSON value, so it sits without quotes:
The four *_label options name the keys inside each Program object. Set them to whatever your system expects. In the example above they produce uid, name, member_uid and member_status:
Unlike categories, this key lists only the Programs the Person is a member of. A Person in no Programs returns an empty array. member_uid and member_status return an empty string when the membership does not carry one.
One named Program
Three tags return a single Program's detail as plain text, so each one stays quoted. Each takes the program_uid of the Program you want. Use them instead of programs, or alongside it:
Rendered:
Each returns an empty string if the Program does not exist on the event, or if the Person is not a member of it. roadshow_name returns the Program's name whether or not the Person is a member, so pair it with roadshow_member_status to tell membership from a plain name lookup.
Because the program_uid is fixed in the template, this form is tied to one event's Programs. Use programs when the same mapping has to work across events.
Field reference
Key | Merge tag | Emits |
|---|---|---|
programs | <<PROGRAMS_LIST|...>> | JSON array of the Programs the Person belongs to, each with the Program UID, Program name, membership UID and membership status. Unquoted in the template. |
roadshow_name | <<PROGRAM_NAME|program_uid:...>> | Text. The named Program's name. |
roadshow_member_uid | <<PROGRAM_MEMBER_UID|program_uid:...>> | Text. The Person's membership UID for the named Program. |
roadshow_member_status | <<PROGRAM_MEMBER_STATUS|program_uid:...>> | Text. The Person's membership status for the named Program. |
The key names starting roadshow_ are examples. Name them after the Program they point at.