Use a supplemental schema to build trigger conditions

AI-generated summary

Genesys Cloud Resource Center provides functionality to use supplemental schemas when building trigger conditions for event-based triggers in Process Automation. When event topic schemas define objects generically without specified fields—such as body, headers, and query objects in webhook invocation topics—users can load supplemental schemas to access undefined fields. A supplemental schema is a JSON schema describing the structure of a single object within an event, enabling users to select fields and generate JSON Paths for trigger conditions. To implement this feature, users navigate to Menu > Orchestration > Triggers, select the Event Based Triggers tab, create a new trigger with a name and description, select a topic, and then click the Load schema icon next to undefined objects. Users paste a JSON schema describing only the selected object's fields into the Load supplemental schema dialog and click Apply. The system validates the schema and displays its fields in the Event Schema section for condition building. Supplemental schemas are stored only for the current browser session and are not saved with the trigger, though conditions and JSON Paths created from them are retained. When reopening a trigger in a new session, the Event Schema section displays only the topic schema, and warnings appear for conditions whose JSON Paths cannot be found. However, these warnings do not affect trigger functionality or workflow invocation. Users must manually maintain copies of supplemental schemas for reload purposes during trigger editing. Required permissions include Process Automation > Trigger – Add, Edit, and View. The documentation includes feedback mechanisms for users to report issues such as inaccurate or outdated content, and offers community support resources for additional assistance. Related documentation covers trigger creation, event-based trigger configuration, and general trigger s, with user roles including agents, administrators, developers/engineers, partners, supervisors, and support personnel able to access these resources

PrerequisitesClick to expand

When you define conditions for an event based trigger, you can select fields in the Event Schema section to generate the JSON Path for each condition. Some event topic schemas might define part of the event only as a generic object, with no information about the fields it contains. For example, in the v2.integrations.inbound.webhook.{id}.invocation topic, the body, headers, and query objects have no defined fields, because their content depends on what each webhook sends.

To select fields under an undefined object, load a supplemental schema. A supplemental schema is a JSON schema that describes the structure of one object in the event. After you apply it, its fields appear in the Event Schema section under that object, and you can select them to build conditions.

Note: Supplemental schemas are stored for the current browser session only. Genesys Cloud doesn’t save them with the trigger. The conditions and JSON Paths that you create from a supplemental schema are saved with the trigger.

To load a supplemental schema:

Click Menu > Orchestration > Triggers.
Select the Event Based Triggers tab.
Click Add Trigger.
Enter a name and description for the trigger, and then click Add.
Under Topic Name, select a topic. The schema of the selected topic appears in the Event Schema section.Load supplemental schema option while creating a trigger." class="alignnone size-full wp-image-435786" srcset="https://help.mypurecloud.com/wp-content/uploads/2026/10/event-schema-sup.png 720w, https://help.mypurecloud.com/wp-content/uploads/2026/10/event-schema-sup-300x263.png 300w" sizes="auto, (max-width: 720px) 100vw, 720px">
In the Event Schema section, locate the object whose fields you want to use. Objects without defined fields display the Load schema icon.
Click the Load schema icon next to the object. The Load supplemental schema dialog box opens.
In the JSON Schema box, paste a JSON schema that describes only the fields of the selected object, not the entire event.
Click Apply.
If the schema is valid, its fields appear in the Event Schema section under the selected object.
Note: For an invalid schema, an error message describes the problem. Correct the schema, and then click Apply again.

To load supplemental schemas for other undefined objects, repeat steps 6-9. Thereafter, build the condition for the trigger as described in Create an event based trigger.

Notes:

Supplemental schemas aren’t saved with the trigger. When you reopen the trigger in a new browser session, the trigger conditions and JSONPaths remain unchanged and the Event Schema section shows only the topic schema. A warning appears for each condition whose JSONPath the schema can’t find. The warning doesn’t affect the trigger, and the trigger still invokes the workflow when an event meets the conditions.
If you replace or remove a supplemental schema, Genesys Cloud doesn’t delete the conditions with the JSONPath that you created from it. Manually update the conditions.
Maintain a copy of the supplemental schemas so that you can reload them when you edit the trigger.

[NEXT] Was this article helpful?

Get user feedback about articles.