Skip to main content

Request Schema

The request schema is a unified map that consolidates all the fields needed across multiple modules—such as Intake Journey, Questionnaires Manager, Notification Events, and so on. It defines the data you want to collect once and use downstream across these processes.

Each field is mapped to the schema in the Request Schema Key configuration in the module builder.

Add a Schema Field

To add a schema field, follow the steps below:

  1. In the Request Schema Fields table, scroll to the bottom of the table and select the Create Row button, preference-table-create-row.png. The Create Row window displays.

  2. Configure by entering values for the relevant fields:

    1. Name (Required) - Enter a descriptive name for the field.

    2. Description - Enter a description of the field.

    3. Request Schema Key (Required) - Enter a unique key for the request field. Tonkean uses this key as a system variable for the dynamic field value.

      Schema keys may not contain spaces or special characters.

    4. Sections - Select a section for the field. Sections help categorize schema fields.

  3. When finished, select Create. Your schema field is added.

In this section: