A payload schema defines the shape of the data body sent to an ERP endpoint: its fields, their data types and how they nest. Open Payload Schemas in the side menu.
Selecting a row opens the schema's detail screen. The detail screen also opens when you select Create. The detail screen has the tabs General and Fields.
Fields and controls
Payload schemas list
Control | Description |
Name | Filters the list by schema name. It is a text box with the placeholder Search. |
Client connection | Narrows the list to schemas that belong to the selected client connection. It is a selector. |
Create | Opens the create form for a new payload schema. |
Delete | Deletes all selected schemas. Select one or more rows before you use it. |
Select this row | Each row has a checkbox, and the table header has a Select all checkbox. |
Rows per page | The table includes this selector together with page navigation. |
List columns
Column | Description |
Name | The schema's display name. |
Method | The HTTP method the schema is associated with, for example |
Endpoint | The API endpoint path the schema targets, without a leading |
Root type | Whether the top-level payload is an Object or an Array. |
General tab
The General tab holds the schema's identity and routing fields. The form marks Name, Client connection, Endpoint, Method and Root type as required.
Field | Description |
Name | Holds the display name for the schema. It is a text field. |
Client connection | Holds the client connection that the schema belongs to. It is a selector. |
Endpoint | Holds the API endpoint path, which you enter without a leading |
Method | Holds the HTTP method for the endpoint. Options: POST, PUT, PATCH, DELETE. |
Root type | Holds the top-level structure of the payload body. Options: Object, Array. |
General tab actions
Action | Description |
Save | Persists changes to the schema. It is active only when there are unsaved edits. On a record with no changes, Save is unavailable. |
Cancel | Discards unsaved changes and returns to the list. |
Delete | Permanently removes the schema and all its fields. |
Fields tab
The Fields tab defines the fields that make up the payload body. Selecting the Fields tab on a schema's detail screen opens the list of its payload fields. The tab has a Payload Fields section with a table of fields. Fields with the data type Association many hold child fields.
Control | Description |
Create Payload Field | Adds a new top-level field to the schema. |
Delete | Deletes all selected top-level fields. |
Name | The field key as it appears in the payload body. |
Data type | The data type of the field, for example |
edit | Each row has this button. It modifies that field's properties. |
Rows per page | The table includes this selector together with page navigation. |
Related