Docs RU

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

2025-07-24 17:37 Настройки
Мы не разрабатывали пакетные решения для интеграции с CRM-системами, однако у нас открытое API, вы можете самостоятельно провести интеграцию. Список всех методов доступен по ссылке и в разделе «Личные данные».

API

API — работает по протоколу http через RESTfull. Существует 3 типа запроса:
  • GET ( получить)
  • PUT (отправить)
  • DELETE (удалить)
Для обращения нужно передавать app_key (ключ аккаунта) и api_key (ключ пользователя от которого отправляются запросы)
API_KEY пользователя находится в разделе Настройка — Мой аккаунт — Личные данные

Где найти App Key (ключ API) для вашего аккаунта?

APP_KEY аккаунта находится в разделе Настройка — Установка Convead
Пример передачи данных описан в каждом методе. Так же, для выполнения запросов можно использовать библиотеки PHP и RUBY.

Нюансы. Через api нельзя создавать новые контакты пользователей. Можно только обновлять/удалять/получать список. Добавлять контакты можно только через события.

Webhooks

Webhooks являются частью документации API и присылается с минимальной задержкой. Ниже приведены существующие типы webhooks. Нужный тип необходимо прописать в строке webhook[topic].
visits/created<br>events/page_view<br>events/login<br>events/update_info<br>events/click_email<br>events/send_email<br>events/open_email<br>events/subscribe<br>events/unsubscribe<br>events/widget_view<br>events/widget_submit<br>events/web_push_send<br>events/web_push_show<br>events/web_push_click<br>events/web_push_subscribe<br>events/web_push_unsubscribe<br>events/purchase<br>events/custom<br>chat/new_msg<br>export/events
Account_id — ID или APP_KEY аккаунта Convead

Webhook_id — параметр назначается автоматически при создании вебхука, но при последующих обращениях к нему (удаление/редактирование) нужно передавать заданный id. По нему система понимает с какой записью работать.

Webhook[application_uid] — ID или APP_KEY аккаунта Convead

Webhook[endpoint] — url-адрес скрипта пользователя, на который отправляется вебхук-запрос.