API Dokumentation

Die API verwendet API-Keys zur Authentifizierung. Du findest und erstellst deine Keys unter Einstellungen → API & Webhooks in deinem Formsly-Dashboard.

Sende den Key als Authorization -Header:

curl https://formsly.ch/api/forms \
  -H "Authorization: Bearer fsk_live_YOUR_API_KEY"

Alternativ kann der Key als Query-Parameter übergeben werden (nicht empfohlen für Produktion, da Keys in Server-Logs erscheinen können):

curl "https://formsly.ch/api/auth/verify?api_key=fsk_live_YOUR_API_KEY"

Prüft ob ein API-Key gültig ist und gibt die zugehörigen Nutzer-Infos zurück.

// Response 200 OK
{
  "user_id": "95ad5a4a-...",
  "username": "name@example.com",
  "email": "name@example.com"
}

Gibt eine Liste aller Formulare des authentifizierten Nutzers zurück.

curl https://formsly.ch/api/forms \
  -H "Authorization: Bearer fsk_live_YOUR_API_KEY"

// Response 200 OK
[
  {
    "id": "2627c769-7f64-4839-befb-ac551d30cdea",
    "title": "Contact Request",
    "description": null,
    "status": "published",
    "updated_at": "2026-03-14T10:12:05.000+00:00",
    "created_at": "2026-03-10T09:02:51.000+00:00"
  }
]

Gibt die neuesten Antworten eines Formulars zurück. Antwortfelder kommen als Array roher Frage-Antwort-Objekte (Feld answers).

curl "https://formsly.ch/api/responses?form_id=2627c769-...&since=2026-03-14T00:00:00Z&limit=50" \
  -H "Authorization: Bearer fsk_live_YOUR_API_KEY"

// Response 200 OK
[
  {
    "id": "f1b00f39-...",
    "form_id": "2627c769-...",
    "submitted_at": "2026-03-14T10:44:38.604+00:00",
    "consent_given": true,
    "answers": [
      { "questionId": "q1", "label": "Name", "value": "Jane Doe" },
      { "questionId": "q2", "label": "Email", "value": "jane@example.com" }
    ]
  }
]

E2E-verschlüsselte Antworten werden NICHT entschlüsselt zurückgegeben (answers ist dann leer). Server-seitig verschlüsselte Felder werden transparent entschlüsselt.

Webhooks senden eine HTTP POST-Anfrage an deine URL, sobald eine neue Antwort eingereicht wird. Jede Auslieferung enthält eine HMAC-SHA256-Signatur im Header Formsly-Signature, mit dem geheimen Webhook-Secret berechnet.

curl -X POST https://formsly.ch/api/webhooks \
  -H "Authorization: Bearer fsk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-app.com/webhook", "form_id": "2627c769-..."}'

// Response 201 Created
{
  "webhook": {
    "id": "abc123-...",
    "url": "https://your-app.com/webhook",
    "secret": "whsec_...",
    "active": true,
    "created_at": "2026-03-18T09:15:23.000+00:00",
    "updated_at": "2026-03-18T09:15:23.000+00:00"
  }
}

curl "https://formsly.ch/api/webhooks?form_id=2627c769-..." \
  -H "Authorization: Bearer fsk_live_YOUR_API_KEY"

curl -X DELETE https://formsly.ch/api/webhooks/abc123-... \
  -H "Authorization: Bearer fsk_live_YOUR_API_KEY"

// POST <your webhook url>
// Header: Formsly-Signature: <hex hmac-sha256 of body using your secret>
{
  "event": "submission.created",
  "timestamp": "2026-03-18T09:15:23.000Z",
  "submission": {
    "id": "f1b00f39-...",
    "formId": "2627c769-...",
    "submittedAt": "2026-03-18T09:15:23.000Z",
    "consentGiven": true,
    "answers": [
      { "questionId": "q1", "label": "Name", "value": "Jane Doe" }
    ]
  }
}

// Node.js – verify the Formsly-Signature header
import crypto from "crypto"

const signature = req.headers["formsly-signature"]
const expected = crypto
  .createHmac("sha256", process.env.FORMSLY_WEBHOOK_SECRET)
  .update(rawBody, "utf8")
  .digest("hex")

if (
  !signature ||
  signature.length !== expected.length ||
  !crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected))
) {
  return res.status(401).end()
}

Formsly ist als Zapier-Integration verfügbar. Verbinde dein Formsly-Konto mit über 7’000 Apps ohne eine einzige Zeile Code.

Zapier nutzt dieselben REST-Endpoints wie deine eigenen Integrationen:

1. Klicke auf den Link oben und akzeptiere die Einladung zur Formsly Zapier-Integration
2. Erstelle einen API-Key unter Einstellungen → API & Webhooks
3. Erstelle einen neuen Zap und wähle Formsly Switzerland als Trigger-App
4. Verbinde dein Konto mit dem API-Key
5. Wähle das gewünschte Formular aus dem Dropdown
6. Konfiguriere deine Action (z.B. Google Sheets, E-Mail, CRM)

// Error response
{
  "error": "Unauthorized"
}