Получение событий для вызова авторассылки

Используйте метод event-controller чтобы получить событие, которые вызовет отправку рассылки определённому клиенту в заданное время.

URL-адрес подключения

Для получения события, вызывающего отправку рассылки, вы должны выполнить POST-запрос на URL-адрес: POST /api/event/schedule/

Пример

{
    "name": "Рассылка Москва",
    "type": "Совершённый заказ",
    "version": "1",
    "subscriberFilter": {
        "address": "phone",
        "type": "79000000000"
    },
    "data": {
        "additionalProp1": {
            "атрибут 1"
        },
        "additionalProp2": {
            "атрибут 2"
        },
        "additionalProp3": {
            "атрибут 3"
        }
    },
    "startTime": "2021-12-01T13:59:17.511Z"
}

Формат запроса

ParameterData typeDescription
namestringНазвание события в свободной форме
typestringТип события (например, «совершённый заказ», «запись на приём», etc.)
versionstringВерсия события
subscriberFilterstringПолучатель сообщения: ID в Платформе edna, номер абонента или ID клиента в Instagram

subscriberFilter включает в себя следующие параметры: address и type. В свою очередь, type может быть idphoneinstagramId, при этом address — это значение, которое зависит от type. Таким образом, например, если type это phone, то address будет номер телефона клиента. Пример:

"subscriberFilter":
{
"address": "79000000000",
"type": "phone",
},
addressstringЗначение, которое зависит от указанного type
typestringТип идентификатора клиента: idphone, или instagramId
idstringИдентификатор клиента в базе данных edna, который создаётся автоматически при создании клиента в edna. Отображается на странице Редактирование пользователя в строке URL, например: 3314 в строке https://app.edna.ru/audience/3314/edit
phonestringНомер телефона клиента
instagramIdstringИдентификатор клиента в Instagram, состоящий из 16 числовых символов. Этот идентификатор создаётся на стороне Facebook, когда клиент первым взаимодействует с Instagram аккаунтом бизнеса. Это значение может быть разным и меняться для одного и того же Instagram клиента
datastringДанные события в свободной форме
additionalPropstringАтрибут события в свободной форме
startTimestringВремя в формате ISO 8601, когда событие будет обработано edna. например, если вы указываете время на час вперёд от текущего, edna сохранит запрос, но обработает только в то время, которое вы указали.

Формат ответа

В качестве ответа от сервера вы должны получить статус с кодом 200.

Получение информации о каскадах