Вебхуки лидов и синхронизация с Google Sheets

Что можно сделать

Когда флипбук захватывает лидов, вы можете направлять каждого нового лида из FlipLink в ваши собственные системы. Эти три эндпоинта позволяют:

• Задать вебхук нового лида — URL, который получает JSON-полезную нагрузку для каждого нового лида.
• Протестировать вебхук — отправить фиктивную полезную нагрузку, чтобы проверить доставку и формат без реального лида.
• Синхронизировать лидов с Google Sheets — добавлять каждого нового лида в указанную вами таблицу.

Перед началом

• API-ключ — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY в каждом запросе.
• {flipbookId} — числовой ID флипбука, возвращаемый из create-by-file / create-by-url (как ID) или из list. Все три эндпоинта принимают его как параметр пути.
• Все запросы идут на базовый URL https://go.fliplink.me.
• Эндпоинты PUT (set-lead-webhook, set-lead-google-sheets) отправляют своё тело как form-urlencoded (не JSON). test-webhook тело не принимает.

Задать вебхук нового лида

Задаёт URL вебхука, который получает каждого нового лида (сохраняется как вебхук нового лида). Используйте тестовый эндпоинт ниже, чтобы проверить, что он срабатывает.

curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=https://example.com/hooks/new-lead'

Ответ:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Протестировать вебхук

Отправляет ТЕСТОВУЮ полезную нагрузку на настроенный вебхук лидов флипбука, чтобы вы могли проверить формат доставки без реального лида. Возвращает ERROR "No lead webhook is configured for this flipbook.", если вебхук не задан. Форма полезной нагрузки совпадает с реальным лидом (ключи: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2), но содержит фиктивные значения (pdf_id:"-1", pdf_name:"Test PDF", …). Реальный лид не сохраняется и уведомление по email не отправляется.

curl -X POST 'https://go.fliplink.me/api/test-webhook/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Синхронизировать лидов с Google Sheets

Подключает захват лидов к Google-таблице — новые лиды добавляются в указанную вами таблицу. Запрос отправляет три поля формы:

• GoogleSheetURL — URL общего доступа таблицы (ссылка, которую вы получаете из диалога «Поделиться» в Google Sheets).
• GoogleSheetIDKey — ID таблицы (длинный идентификатор в URL таблицы, между /d/ и /edit).
• GoogleSheetName — имя листа (вкладки), в который добавлять строки, например Sheet1.

curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=https://docs.google.com/spreadsheets/d/1A2B3C4D5E6F7G8H9I0J/edit?usp=sharing' \
  --data-urlencode 'GoogleSheetIDKey=1A2B3C4D5E6F7G8H9I0J' \
  --data-urlencode 'GoogleSheetName=Sheet1'

Ответ:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Возможные ошибки

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key (или Authorization: Bearer) присутствует и указан верно.
• Неизвестный {flipbookId} (или не принадлежащий вашему ключу) → HTTP 200 с { "Result": "ERROR", "Message": "Item not found" }.
• Неизвестное поле тела запроса или опечатка в нём (в двух эндпоинтах PUT) → HTTP 200 с { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }.

Простое правило: Result: "OK" означает, что изменение применено; Result: "ERROR" означает, что нет — читайте Message, чтобы узнать причину.

Примечания

• Тестовый эндпоинт возвращает ERROR "No lead webhook is configured for this flipbook.", когда у флипбука не задан вебхук — сначала настройте его через set-lead-webhook.
• Тестовая полезная нагрузка никогда не сохраняет реального лида и никогда не отправляет уведомление по email.