Информация о доступных триггерах внешнего события

Метод позволяет получить список всех доступных для запуска триггеров внешнего события по идентификатору бота (agentStageId).

Запрос

GET /api/v1/runtime/simple/external/events/{agentStageId}

Параметры пути (path)

Имя параметра	Тип	Описание	Дополнительно
agentStageId	string	Идентификатор бота. Для его получения на странице бота перейдите в Настройки бота > API.	Обязательный

Тело ответа

{
    "externalEventId": "string",
    "externalEventName": "string",
    "parameters": {
        "{variableCode}": {
            "name": "string",
            "type": "string"
        }
    }
}

Свойства

Имя параметра	Тип	Описание
externalEventId	string	Идентификатор внешнего события.
externalEventName	string	Наименование внешнего события.
parameters	object	Список переменных, доступных для заполнения.

HTTP коды ответов

Код ответа	Описание
200	Получение списка доступных триггеров успешно завершено.
401	Ошибка авторизации. Необходимо проверить X-Token.
404	Не найден бот с указанным agentStageId.
500	Внутренняя ошибка сервера. Тело ответа содержит подробности об ошибке.

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: X-Token.

Пример запроса

curl --location 'https://client.elma-bot.ai/api/v1/runtime/simple/external/events/642985a04823815ca247070a' \
--header 'X-Token: 73802c1e-33bd-4b54-b491-1dc496d58add'

Пример ответа

{
    "externalEventId": "acquaintanceNotification",
    "externalEventName": "Ознакомление с документом",
    "parameters": {
        "tekst_soobschenia": {
            "name": "Текст сообщения",
            "type": "String"
        },
        "data_okonchania": {
            "name": "Дата окончания",
            "type": "DateTime"
        }
    }
}