Sessions
An ordered sequence of steps that can be used to build conversational UIs (eg: product onboarding).
Create session
POST
https://api.finqware.com/v1/sessions
Initializes an on-boarding session for a specified skill.
The tenant_user_id may be any string that uniquely identifies an end-user using your tenant app (eg: uuid, opaque string, etc).
Request Body
Name | Type | Description |
---|---|---|
tenant_user_id* | string | A unique identifier for your end-user. |
client_id* | string | An identifier for your tenant app. |
client_app_key* | string | Authorization key. |
skill* | string | The skill you're implementing. |
Submit step for session
POST
https://api.finqware.com/v1/sessions/:id/steps
Submits data for a certain session step.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | The session id. |
Request Body
Name | Type | Description |
---|---|---|
client_id* | string | An identifier for your tenant app. |
nonce* | string | A temp key received from the previous step. |
skill* | string | The skill you're implementing. |
step* | string | The name of the step you're submitting data for. |
data* | object | The payload for this specific step. |
Last updated