Dashform

Referencia de la API

Guía de integración para Zapier y otras plataformas — autenticación, endpoints y cargas útiles de webhooks.

La API de Dashform te permite leer formularios y respuestas, y suscribirte a eventos de nuevos envíos desde Zapier y otras plataformas.

Autenticación

Dashform utiliza OAuth 2.0 para la autenticación. Todas las solicitudes a la API deben incluir un token de acceso válido:

Authorization: Bearer YOUR_ACCESS_TOKEN

Endpoints de OAuth

  • GET /api/oauth/authorize — página de autorización
  • POST /api/oauth/token — intercambia el código por un token

Obtener el usuario actual

GET /api/v1/me

Devuelve información sobre el usuario autenticado.

{
  "id": "user_123",
  "name": "John Doe",
  "email": "john@example.com"
}

Listar formularios

GET /api/v1/forms

Devuelve una lista de los formularios que pertenecen al usuario autenticado.

[
  {
    "id": "form_123",
    "name": "Contact Form",
    "description": "Main contact form"
  }
]

Webhooks (REST hooks)

Suscribirse

POST /api/webhooks/zapier/subscribe

Suscríbete a los eventos de respuestas de formularios.

Cuerpo de la solicitud:

{
  "target_url": "https://hooks.zapier.com/...",
  "form_id": "form_123",
  "subscription_id": "sub_123"
}

form_id y subscription_id son opcionales — omite form_id para suscribirte a las respuestas de todos los formularios.

Respuesta:

{
  "id": "hook_123",
  "status": "subscribed"
}

Cancelar la suscripción

DELETE /api/v1/hooks/unsubscribe/:id

Cancela la suscripción a las notificaciones de webhook.

{
  "success": true,
  "message": "Hook deleted successfully"
}

Listar hooks

GET /api/v1/hooks

Lista todas las suscripciones de webhook activas.

[
  {
    "id": "hook_123",
    "form_id": "form_123",
    "target_url": "https://hooks.zapier.com/...",
    "status": "active"
  }
]

Triggers

GET /api/v1/triggers/new-submission

Obtén las respuestas de formularios recientes para probar los triggers. Devuelve las 3 respuestas más recientes.

Parámetros de consulta:

  • form_id — opcional: filtra por un formulario 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"
  }
]

Carga útil del webhook

Cuando se recibe una nueva respuesta de formulario, Dashform envía una solicitud POST a la URL de tu webhook con la siguiente carga útil:

{
  "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"
}

On this page