Stories

A story is a conversation scenario between customers and the bot. You can design the bot to do things like receiving pizza orders or scheduling doctor appointments or whatever you want.

List all stories

Returns list of all stories.

Request URL

curl --request GET \
	--url https://api.chatbot.com/stories \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response Example

[
    {
        "id": "58ee11d75fb5580005cb8199",
        "name": "Example name",
        "description": "Example description",
        "integrations": [],
        "metrics": [
            {
                date: "2018-01-16",
                conversations: 15
            },
            [...]
        ]
    }
]

Properties

integrations

A string array that describes which integrations story is connected with. Possible values: livechat, messenger, slack, widget.

metrics

Get a single story

Returns single story for the given id.

Request URL

curl --request GET \
	--url https://api.chatbot.com/stories/:ID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response Example

{
    "id": "58ee11d75fb5580005cb8199",
    "name": "Example story name",
    "description": "Example story description",
    "order": [
        "58ee2d045d033800059a3f7e"
    ],
    "interactions": {
        "58ee2d045d033800059a3f7e": {
            "name": "parent",
            "root": true,
            "references": [],
            "contextOut": [
                "58ee2d105fb5580005cb81aa"
            ],
            "webhook": "",
            "id": "58ee2d045d033800059a3f7e"
        },
        "58ee2d105fb5580005cb81aa": {
            "name": "child",
            "root": false,
            "references": [],
            "contextOut": [],
            "webhook": "",
            "id": "58ee2d105fb5580005cb81aa"
        }
    }
}

Properties

Add a new story

Create a new story:

Request URL

curl --request POST \
	--url https://api.chatbot.com/stories \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
    {
      "name": "Story name",
      "description": "Story description"
    }
'

Response Example

{
    "id": "58ee2e085d033800059a3f7f",
    "timestamp": "2017-04-12T13:39:20.721Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Properties

Update a story

Update story with the given id.

Request URL

curl --request PUT \
	--url https://api.chatbot.com/stories/:ID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
    {
      "name": "Story name",
      "description": "Story description"
    }
'

Response Example

{
    "timestamp": "2017-04-12T13:40:40.260Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Properties

Delete a story

Removes a story with the given id.

Request URL

curl --request DELETE \
	--url https://api.chatbot.com/stories/:ID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json'

Response Example

{
    "timestamp": "2017-04-12T13:41:47.020Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}