Dashform

API-Referenz

Integrationsleitfaden für Zapier und andere Plattformen – Authentifizierung, Endpunkte und Webhook-Payloads.

Mit der Dashform-API kannst du Formulare und Antworten auslesen und dich von Zapier und anderen Plattformen aus für Ereignisse bei neuen Einsendungen anmelden.

Authentifizierung

Dashform verwendet OAuth 2.0 für die Authentifizierung. Alle API-Anfragen müssen ein gültiges Zugriffstoken enthalten:

Authorization: Bearer YOUR_ACCESS_TOKEN

OAuth-Endpunkte

  • GET /api/oauth/authorize – Autorisierungsseite
  • POST /api/oauth/token – Code gegen Token tauschen

Aktuellen Benutzer abrufen

GET /api/v1/me

Gibt Informationen über den authentifizierten Benutzer zurück.

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

Formulare auflisten

GET /api/v1/forms

Gibt eine Liste der Formulare zurück, die dem authentifizierten Benutzer gehören.

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

Webhooks (REST-Hooks)

Abonnieren

POST /api/webhooks/zapier/subscribe

Abonniere Ereignisse für Formularantworten.

Anfrage-Body:

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

form_id und subscription_id sind optional – lass form_id weg, um Antworten aus allen Formularen zu abonnieren.

Antwort:

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

Abbestellen

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

Webhook-Benachrichtigungen abbestellen.

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

Hooks auflisten

GET /api/v1/hooks

Liste alle aktiven Webhook-Abonnements auf.

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

Trigger

GET /api/v1/triggers/new-submission

Rufe aktuelle Formularantworten zum Testen von Triggern ab. Gibt die 3 neuesten Antworten zurück.

Query-Parameter:

  • form_id – optional: nach einem bestimmten Formular filtern
[
  {
    "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"
  }
]

Webhook-Payload

Wenn eine neue Formularantwort eingeht, sendet Dashform eine POST-Anfrage an deine Webhook-URL mit der folgenden 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"
}

On this page