Webhooks

Webhooks в digital pipeline

Webhooks – это уведомление сторонних приложений посредством отправки уведомлений о событиях, произошедших в amoCRM. Вы можете настроить HTTP адреса ваших приложений и связанные с ними рабочие правила в настройках digital pipeline, в amoCRM.

Подробнее о технологии можно посмотреть в разделе WebHooks REST API. Однако, не смотря на тот факт, что применяемая технология уведомлений Webhooks в digital pipeline такая же, как и в разделе amoМаркет вашего аккаунта, она имеет несколько отличий.

  • Первое отличие, более ограниченный список событий по которым будет реагировать отправка уведомлений.
  • Второе отличие, из digital pipeline, в отличии от amoМаркет, webhook отправляется только один раз, по произошедшему указанному событию. Без попыток повторной отправки.

Список возможных событий

  • При заполнении анкеты
  • При входящем письме
  • При входящем звонке
  • После захода на сайт

Чтобы создать webhook

Пройдите в меню настроек digital pipeline из раздела Сделки/Покупатели и выберите "добавить триггер", под нужным вам этапом..

Далее выберите "API: отправить webhook".

Выберите событие, при котором будет отправляться webhook.

Введите URL, по которому будет отправляться webhook.

Формат отправляемых данных

Webhook отправляет на стороннее приложение POST переменную, которая содержит массив вида {"entity":{"action":{массив полей сущности}}}.

Параметры

Параметр Описание
leads Сущность: "Сделка"
customers Сущность: "Покупатель"

Параметры событий

Параметр Описание
call_in Событие при входящем вызове
chat Событие при входящем сообщении из чата
site_visit Событие при заходе на сайт
mail_in Событие при входящем письме
status Событие при переходе в этап, только у сделок
period Событие при смене периода, только у покупателя

Параметры полей сущности

Параметр Описание
id id элемента сущности
old_pipeline_id id старой цифровой воронки, только у сделок
pipeline_id id новой цифровой воронки, только у сделок
old_status_id id старого статуса, только у сделок
status_id id нового статуса, только у сделок
old_period_id id старого периода, только у покупателя
period_id id нового периода, только у покупателя

Пример

При входящем письме, для сделки

{
    "leads": {
        "mail_in": [
            {
                "id": 4921027,
                "pipeline_id": 752662,
                "status_id": 16203334
            }
        ]
    }
}

При переходе в этап, для сделки

{
    "leads": {
        "status": [
            {
                "id": 4831596,
                "old_pipeline_id": 752662,
                "pipeline_id": 752662,
                "old_status_id": 16203334,
                "status_id": 16203337
            }
        ]
    }
}