Главная / Документация

Документация

Все, что нужно разработчику: контракт REST API, каталог исходящих вебхуков, справочник JS SDK и гайды по подключению каналов (Telegram, VK, MAX, почта, AmoCRM, Bitrix24).

REST API

Контакты, компании, события, интеграционные эндпоинты. OpenAPI 3.1 + Try It.

Вебхуки

Исходящие события, формат пейлоада, проверка подписи HMAC-SHA256.

JS SDK

Методы _nf(): identify, group, event, reset. Установка виджета.

Гайды по каналам

Как подключить Telegram-бот, VK-сообщество, почтовый ящик или CRM.

Быстрый старт

Установите виджет на сайт — один тег перед </body>:

<script>
    (function (w, d, s, o, f, js, fjs) {
        w[o] = w[o] || function () { w[o].q = w[o].q || []; w[o].q.push(arguments); };
        js = d.createElement(s); fjs = d.getElementsByTagName(s)[0];
        js.id = o; js.src = f; js.async = 1;
        fjs.parentNode.insertBefore(js, fjs);
    }(window, document, 'script', '_nf', 'https://cp.notiflow.ru/js/widget.js'));
    _nf('init', { api_key: '{api_key}' });
</script>

Идентифицируйте авторизованного пользователя сразу после логина — один объект-аргумент, user_id обязателен:

_nf('identify', {
  user_id: 'user_12345',
  email: 'ivanov@site.ru',
  name: 'Иван Иванов',
  plan: 'pro'
});

Где взять API-ключ

Личный ключ кабинета: Настройки → API-ключи на cp.notiflow.ru. Передавать только в заголовке X-Api-Key.

Postman-коллекция

Скачать: api.postman_collection.json — генерируется из того же OpenAPI, что и интерактивная документация.