Справочник по API
Руководство по интеграции с Zapier и другими платформами — аутентификация, эндпоинты и полезная нагрузка вебхуков.
API Dashform позволяет читать формы и ответы, а также подписываться на события о новых отправках из Zapier и других платформ.
Аутентификация
Dashform использует OAuth 2.0 для аутентификации. Все запросы к API должны содержать действительный токен доступа:
Authorization: Bearer YOUR_ACCESS_TOKENЭндпоинты OAuth
GET /api/oauth/authorize— страница авторизацииPOST /api/oauth/token— обмен кода на токен
Получить текущего пользователя
GET /api/v1/meВозвращает информацию об аутентифицированном пользователе.
{
"id": "user_123",
"name": "John Doe",
"email": "john@example.com"
}Список форм
GET /api/v1/formsВозвращает список форм, принадлежащих аутентифицированному пользователю.
[
{
"id": "form_123",
"name": "Contact Form",
"description": "Main contact form"
}
]Вебхуки (REST hooks)
Подписка
POST /api/webhooks/zapier/subscribeПодпишитесь на события об ответах на формы.
Тело запроса:
{
"target_url": "https://hooks.zapier.com/...",
"form_id": "form_123",
"subscription_id": "sub_123"
}Поля form_id и subscription_id необязательны — опустите form_id, чтобы
подписаться на ответы по всем формам.
Ответ:
{
"id": "hook_123",
"status": "subscribed"
}Отписка
DELETE /api/v1/hooks/unsubscribe/:idОтпишитесь от уведомлений вебхука.
{
"success": true,
"message": "Hook deleted successfully"
}Список хуков
GET /api/v1/hooksСписок всех активных подписок на вебхуки.
[
{
"id": "hook_123",
"form_id": "form_123",
"target_url": "https://hooks.zapier.com/...",
"status": "active"
}
]Триггеры
GET /api/v1/triggers/new-submissionПолучите недавние ответы на формы для тестирования триггеров. Возвращает 3 самых свежих ответа.
Параметры запроса:
form_id— необязательный: фильтрация по конкретной форме
[
{
"id": "reply_123",
"form_id": "form_123",
"form_name": "Contact Form",
"data": {
"name": "John Doe",
"email": "john@example.com"
},
"created_at": "2025-01-01T12:00:00Z"
}
]Полезная нагрузка вебхука
Когда поступает новый ответ на форму, Dashform отправляет POST-запрос на URL
вашего вебхука со следующей полезной нагрузкой:
{
"id": "reply_123",
"form_id": "form_123",
"form_name": "Contact Form",
"data": {
"name": "John Doe",
"email": "john@example.com",
"message": "Hello!"
},
"created_at": "2025-01-01T12:00:00Z"
}