API Webhooks

Webhooks реализованы с помощью инструмента Триггеры в WireCRM,
для того чтобы настроить Webhook нужно добавить в систему триггер с уведомлением на URL.

Где настроить триггеры

Для организаций: Настройки → Организации → Триггеры
https://secure.wirecrm.com/settings/accounts/triggers
Для сделок: Настройки → Сделки → Триггеры
https://secure.wirecrm.com/settings/deals/triggers
Для контактов: Настройки → Контакты → Триггеры
https://secure.wirecrm.com/settings/contacts/triggers
и тд.

Пример настройки

Добавьте триггер на событие в разделе Сделки. Добавьте URL, на который будет отправляться Webhook. Триггер сработает на перевод сделки на этап "Успешно", на указанный URL будет отправлено уведомление.

Структура уведомления

object — объект в котором сработал Webhook, например, accounts, contacts, deals, activities
event — кодовое название события, например, change_status, change_stage
msg — массив, в котором будет содержаться информация по измененному объекту, например, ID записи.

Пример Webhook сделок

{

  "object": "deals",

  "event": "change_stage",

  "msg": {

    "id": "1930161",

    "stage": "3724",

    "name": "Сделка",

    "description": "",

    "source": 0,

    "currency": 1,

    "amount": 0,

    "account": null,

    "contact": null

  }

}

Пример Webhook сделок с позициями

{

  "object": "deals",

  "event": "change_stage",

  "msg": {

    "id": "818622",

    "stage": "3724",

    "name": "Сделка с позициями",

    "description": "",

    "source": 0,

    "currency": 1,

    "amount": 2560,

    "account": 5146217,

    "contact": 2448844,

    "positions": [

      {

        "item_names": "Продукт",

        "item_quantities": 1,

        "item_prices": 230,

        "item_discounts": 0,

        "item_markups": 0,

        "item_amounts": 230,

        "item_measures": "",

        "item_products": 439534,

        "item_codes": "",

        "item_descriptions": ""

      }

    ]

  }

}

Метод отправки и обработка данных

Метод отправки: POST
Content-Type: application/json
Данные отправляются в формате JSON методом POST, для их чтения в PHP используйте php://input — это поток для чтения сырых данных из тела HTTP-запроса.

Требования к обработчику

Успешно принятый Webhook должен ответить HTTP code 200.
Ответ должен быть обработан в течение таймаута 30 секунд.

Пример обработки на PHP

//Пример обработки полученного уведомления на PHP:

$data = file_get_contents('php://input');

$arr = json_decode($data,true);