Referência da API
Guia de integração para o Zapier e outras plataformas — autenticação, endpoints e payloads de webhook.
A API da Dashform permite-lhe ler formulários e respostas e subscrever eventos de novas submissões a partir do Zapier e de outras plataformas.
Autenticação
A Dashform utiliza OAuth 2.0 para autenticação. Todos os pedidos à API têm de incluir um token de acesso válido:
Authorization: Bearer YOUR_ACCESS_TOKENEndpoints OAuth
GET /api/oauth/authorize— página de autorizaçãoPOST /api/oauth/token— trocar o código por um token
Obter o utilizador atual
GET /api/v1/meDevolve informações sobre o utilizador autenticado.
{
"id": "user_123",
"name": "John Doe",
"email": "john@example.com"
}Listar formulários
GET /api/v1/formsDevolve uma lista dos formulários pertencentes ao utilizador autenticado.
[
{
"id": "form_123",
"name": "Contact Form",
"description": "Main contact form"
}
]Webhooks (REST hooks)
Subscrever
POST /api/webhooks/zapier/subscribeSubscreva eventos de respostas a formulários.
Corpo do pedido:
{
"target_url": "https://hooks.zapier.com/...",
"form_id": "form_123",
"subscription_id": "sub_123"
}form_id e subscription_id são opcionais — omita form_id para subscrever as
respostas de todos os formulários.
Resposta:
{
"id": "hook_123",
"status": "subscribed"
}Cancelar subscrição
DELETE /api/v1/hooks/unsubscribe/:idCancele a subscrição das notificações de webhook.
{
"success": true,
"message": "Hook deleted successfully"
}Listar hooks
GET /api/v1/hooksListe todas as subscrições de webhook ativas.
[
{
"id": "hook_123",
"form_id": "form_123",
"target_url": "https://hooks.zapier.com/...",
"status": "active"
}
]Acionadores
GET /api/v1/triggers/new-submissionObtenha as respostas recentes a formulários para testar acionadores. Devolve as 3 respostas mais recentes.
Parâmetros de consulta:
form_id— opcional: filtrar por um formulário específico
[
{
"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"
}
]Payload do webhook
Quando é recebida uma nova resposta a um formulário, a Dashform envia um pedido
POST para o seu URL de webhook com o seguinte payload:
{
"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"
}