Документация API
Для получения информации по лидам в свой сервер воспользуйтесь API. Сообщения с информацией могут отправляться двумя способами: сразу после прохождения проекта пользователем и раз в сутки по всем сессиям.
В редакторе проекта
Перейдите в Настройки проекта > Доступ > API. Функция доступна только на тарифах Для бренда и Для агентства.
Вам необходимо выбрать Включено, указать адрес вашего сервера и ключ, с которым ваш сервер разрешит отправлять ему информацию.
Формат сообщений
Method: POST
Content-Type: application/json
Authentication headers:
Content-Type: application/json
Authentication headers:
- Authorization: Bearer <your_webhook_api_key>
- X-API-Key: <your_webhook_api_key>
Содержимое сообщения:
{
ㅤ"public_id": "550e8400-e29b-41d4-a716-446655440000",
ㅤ"project_id": 45,
ㅤ"session_number": 7,
ㅤ"visitor_id": "visitor_abc",
ㅤ"status": "started",
ㅤ"form_data": {
ㅤㅤ"email": "user@example.com",
ㅤㅤ"name": "Ivan"
ㅤ},
ㅤ"ip_address": "1.2.3.4",
ㅤ"created_at": "2026-05-29T10:00:00Z"
}
ㅤ"public_id": "550e8400-e29b-41d4-a716-446655440000",
ㅤ"project_id": 45,
ㅤ"session_number": 7,
ㅤ"visitor_id": "visitor_abc",
ㅤ"status": "started",
ㅤ"form_data": {
ㅤㅤ"email": "user@example.com",
ㅤㅤ"name": "Ivan"
ㅤ},
ㅤ"ip_address": "1.2.3.4",
ㅤ"created_at": "2026-05-29T10:00:00Z"
}
Ежесуточная периодичность
Такой формат собирает все сессии за предыдущие сутки и отправляет их одним сообщением в 8:00 утра.
Максимальный размер батча — 100 сессий.
Максимальный размер батча — 100 сессий.
{
ㅤ"timestamp":
ㅤㅤ"2026-05-29T10:05:00Z",
ㅤㅤ"sessions": [
ㅤㅤㅤ{
ㅤㅤㅤㅤ"public_id": "550e8400-e29b-41d4-a716-446655440000",
ㅤㅤㅤㅤ"project_id": 45,
ㅤㅤㅤㅤ"session_number": 7,
ㅤㅤㅤㅤ"visitor_id": "visitor_abc",
ㅤㅤㅤㅤ"status": "started",
ㅤㅤㅤㅤ"form_data": {
ㅤㅤㅤㅤㅤ"email": "user@example.com",
ㅤㅤㅤㅤㅤ"name": "Ivan"
ㅤㅤㅤㅤ},
ㅤㅤㅤㅤ"ip_address": "1.2.3.4",
ㅤㅤㅤㅤ"created_at": "2026-05-29T10:00:00Z"
ㅤㅤㅤ},
ㅤㅤㅤ{
ㅤㅤㅤㅤ"public_id": "550e8400-e29b-41d4-a716-446652240000",
ㅤㅤㅤㅤ"project_id": 45,
ㅤㅤㅤㅤ"session_number": 8,
ㅤㅤㅤㅤ"visitor_id": "visitor_abc",
ㅤㅤㅤㅤ"status": "started",
ㅤㅤㅤㅤ"form_data": {
ㅤㅤㅤㅤㅤ"email": "user@example.com",
ㅤㅤㅤㅤㅤ"name": "Ivan"
ㅤㅤㅤㅤ},
ㅤㅤㅤㅤ"ip_address": "1.2.3.4",
ㅤㅤㅤㅤ"created_at": "2026-05-29T10:00:00Z"
ㅤㅤㅤ},
ㅤ"timestamp":
ㅤㅤ"2026-05-29T10:05:00Z",
ㅤㅤ"sessions": [
ㅤㅤㅤ{
ㅤㅤㅤㅤ"public_id": "550e8400-e29b-41d4-a716-446655440000",
ㅤㅤㅤㅤ"project_id": 45,
ㅤㅤㅤㅤ"session_number": 7,
ㅤㅤㅤㅤ"visitor_id": "visitor_abc",
ㅤㅤㅤㅤ"status": "started",
ㅤㅤㅤㅤ"form_data": {
ㅤㅤㅤㅤㅤ"email": "user@example.com",
ㅤㅤㅤㅤㅤ"name": "Ivan"
ㅤㅤㅤㅤ},
ㅤㅤㅤㅤ"ip_address": "1.2.3.4",
ㅤㅤㅤㅤ"created_at": "2026-05-29T10:00:00Z"
ㅤㅤㅤ},
ㅤㅤㅤ{
ㅤㅤㅤㅤ"public_id": "550e8400-e29b-41d4-a716-446652240000",
ㅤㅤㅤㅤ"project_id": 45,
ㅤㅤㅤㅤ"session_number": 8,
ㅤㅤㅤㅤ"visitor_id": "visitor_abc",
ㅤㅤㅤㅤ"status": "started",
ㅤㅤㅤㅤ"form_data": {
ㅤㅤㅤㅤㅤ"email": "user@example.com",
ㅤㅤㅤㅤㅤ"name": "Ivan"
ㅤㅤㅤㅤ},
ㅤㅤㅤㅤ"ip_address": "1.2.3.4",
ㅤㅤㅤㅤ"created_at": "2026-05-29T10:00:00Z"
ㅤㅤㅤ},
Ожидаемый ответ
Сервер-получатель должен вернуть HTTP-код 2xx для подтверждения успешного получения webhook. Рекомендуется использовать 200 OK или 204 No Content.
Для одиночной отправки Gamifig ожидает ответ в течение 10 секунд, для пакетной отправки — в течение 30 секунд.
Ответы вне диапазона 2xx и отсутствие ответа в пределах таймаута считаются ошибкой доставки.