Formy developer docs: API, webhooks, embed SDK and MCP

The docs

• Formy REST API: tokens, abilities, endpoints and errors

  Authenticate with a personal access token, see exactly which routes each ability opens, and manage workspaces, forms and webhooks by code.

  Read REST API

• Formy webhooks: payload, X-Formy-Signature and retries

  The events, headers and JSON payload of each delivery, how to verify X-Formy-Signature, and what Formy does when your server is down.

  Read Webhooks

• Automation endpoints for Make, n8n and HTTP clients

  Validate a token, list workspaces, forms and field IDs, and subscribe a Make webhook with a sample delivery for field mapping.

  Read Automation endpoints

• Send a filled-in document for signature by API

  One POST sends a document that already carries your values to one person for signature, metered like a document sent from the product.

  Read Signing requests

• Embed a Formy form with the JavaScript SDK

  The embed snippet, the SDK's events and methods, how the handshake locks messages to your origin, and what an embedded form cannot do.

  Read Embed SDK

• Prefill parameters and field IDs

  Where to find a field's ID, the URL value format for each field type, locked and hidden fields, and which values win when several sources disagree.

  Read Prefill and field IDs

• Formy MCP server: endpoint, OAuth, scopes and tools

  The endpoint and its transport, OAuth discovery, which clients can register, the scopes, the read-only tools available today, and the limits.

  Read MCP server

Quickstart: your first call

1. In Formy, open your account settings, then גישה ל-API, and click יצירת API Access Token חדש. Name the token, keep only the הרשאות it needs, and copy it: it is shown once.
2. Check it with GET /external/validate, which answers with the name and email of the account the token acts for.
3. List your workspaces with GET /external/workspaces, a workspace's forms with GET /external/forms?workspace_id=, and a form's field IDs with GET /external/forms/{form}/fields.
4. Add a webhook to the form, pointed at your server, and verify X-Formy-Signature on each delivery.

export FORMY_TOKEN='paste-your-token-here'

curl https://formy.co.il/api/external/validate \
  -H "Authorization: Bearer $FORMY_TOKEN" -H "Accept: application/json"
# {"name":"Dana Cohen","email":"dana@example.com"}

curl https://formy.co.il/api/external/workspaces \
  -H "Authorization: Bearer $FORMY_TOKEN" -H "Accept: application/json"
# [{"id":1,"name":"Acme Ltd","label":"Acme Ltd","value":1}]

Conventions

• One base URL, https://formy.co.il/api, with no version in the path. Requests and responses are JSON.
• A form is addressed by its numeric ID or by its slug, the last part of its public link.
• Timestamps are UTC, in ISO 8601.
• Error messages are in Hebrew, as the product is; branch on the status code and the code or type fields.
• A route a token may not use answers 404, not 403, so a token cannot map what exists.

Self-hosted installs and formy.co.il

Formy's source is offered under the GNU AGPL, and a self-hosted install starts from the code's defaults. Several switches that formy.co.il turns on are off in a fresh install, so a self-hosted server can behave differently from these pages:

The switch for each is in the configuration files of the source code, which the source code page offers.

Formy is an Israeli, Hebrew-first online form builder for businesses and organizations, with electronic signatures inside the form and documents sent out for signature.