Get extended schema

post

https://{basePath}/embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/extended-schema

Retrieves the extended schema for a selected action or trigger in an Embedded Journey instance

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use this API to fetch additional input and output fields that are generated dynamically based on the selected app, action or trigger, input values, and connection. The returned schema can be used to render fields in the Embedded UI or a custom configuration interface.

Path Params

embeddedJourneyInstanceId

string

required

Unique ID of the Embedded Journey instance for which the extended schema must be retrieved

Body Params

appAlias

string

required

Alias of the app for which the extended schema must be fetched

actionAlias

string

Alias of the action for which the extended schema is required. Use this when fetching schema for an action

triggerAlias

string

Alias of the trigger for which the extended schema is required. Use this when fetching schema for a trigger

input

json

required

Input values required to generate the extended schema. The structure depends on the selected app and action or trigger. For example, {"question": "Hi","conversation_id": "1234", "answerType": "string","retryHelp": "valid" }. The input can be obtained from the Get app configuration API

connectionId

string

required

Unique ID of the connection used to fetch the extended schema

Responses

200Ok

401Unauthorized