Go to appAcademyWhat's new?

                                                        Building schema from JSON

                                                        This feature is currently being rolled out incrementally and may not yet be available to all users. Full availability is expected soon. If you're interested in using this feature, please reach out to your Customer Success Manager or Account Executive.

                                                        The Build from JSON tool lets you quickly create object or array schemas by pasting JSON data, instead of manually defining properties. This feature works in two contexts:

                                                        1. Step properties

                                                        2. Schema editing for API Management (APIM) and Callable workflows

                                                        Building step properties
                                                        Copy

                                                        When editing step properties, you can use Build from JSON for objects and arrays without restricted type interfaces (e.g. that accept only certain values).

                                                        1. Locate the "From JSON" button next to a property.

                                                        2. Paste your JSON or edit the sample in the modal.

                                                        3. Click "Preview schema" to view the generated schema preview.

                                                        4. Click "Apply to property" to update the property, "Back to editing" to amend the JSON, or close the modal to discard changes.

                                                        Building schema for API Management and Callable workflows
                                                        Copy

                                                        The Build from JSON tool is also available for editing schema.

                                                        1. Locate the "Build from JSON" button in the schema editor modal.

                                                        2. Paste your JSON or edit the sample in the modal.

                                                        3. Click "Preview schema" to apply the generated schema in the modal.

                                                        4. Click "Save" to apply the changes, or "Cancel" or close the modal to discard changes.

                                                        Example
                                                        Copy

                                                        Input:

                                                        { "name": "example", "details": { "age": 30, "location": "NYC" } }

                                                        Generated schema:

                                                        Object with name (string) and details (object with age (number) and location (string)).