API reference · reference
Forms API reference
Submit forms, list submissions, and register webhooks.
Forms API
POST /forms/:id/submit
Submit a form programmatically (bypasses the rendered form). No auth required for public forms.
Body: JSON matching the form's schema. Files upload as multipart.
Response:
{ "submissionId": "…", "status": "ok", "paymentUrl": "…" }
paymentUrl is present when the form has a Payment field — redirect the user there.
GET /forms/:id/submissions
Auth required. Returns paginated submissions.
POST /forms/:id/webhooks
Register a webhook subscriber for a form.
{ "url": "https://…/hook", "events": ["submitted", "paid"], "secret": "…" }
Webhook payload
Every request POSTs JSON with an X-Wordsafe-Signature HMAC-SHA256 header:
signature = hex(hmac_sha256(secret, raw_body))
Verify before processing.