# OpnForm Technical Docs

## Docs

- [API Keys](https://docs.opnform.com/api-reference/api-keys.md): Generate and manage Personal Access Tokens on OpnForm.
- [Changelog](https://docs.opnform.com/api-reference/changelog.md): Notable updates to the OpnForm API.
- [Create Form](https://docs.opnform.com/api-reference/forms/create-form.md): Create a new form; requires forms-write ability.
- [Delete Form](https://docs.opnform.com/api-reference/forms/delete-form.md): Delete a form. Requires `forms-write`.
- [Get Form](https://docs.opnform.com/api-reference/forms/get-form.md): Retrieve a single form.
- [List Workspace Forms](https://docs.opnform.com/api-reference/forms/list-workspace-forms.md): Retrieve all forms within a specific workspace. Returns lightweight form summaries (excludes `properties`). Use the Get Form endpoint to retrieve the full form with all fields. Requires `forms-read` ability.
- [Update Form](https://docs.opnform.com/api-reference/forms/update-form.md): Update an existing form. Requires `forms-write`.
- [Create Webhook Integration](https://docs.opnform.com/api-reference/integrations/create-webhook-integration.md): Create a new webhook integration for a form. Requires `manage-integrations` ability.
- [Delete Webhook Integration](https://docs.opnform.com/api-reference/integrations/delete-webhook-integration.md): Delete a webhook integration. Requires `manage-integrations` ability.
- [List Form Integrations](https://docs.opnform.com/api-reference/integrations/list-form-integrations.md): List all integrations configured for a form. Requires `manage-integrations` ability.
- [List Webhook Events](https://docs.opnform.com/api-reference/integrations/list-webhook-events.md): List past webhook dispatch events for an integration. Requires `manage-integrations` ability.
- [Update Webhook Integration](https://docs.opnform.com/api-reference/integrations/update-webhook-integration.md): Update an existing webhook integration. Requires `manage-integrations` ability.
- [Validating Webhook Signatures](https://docs.opnform.com/api-reference/integrations/webhook-security.md): Learn how to validate webhook signatures from OpnForm to ensure authenticity and integrity
- [Introduction](https://docs.opnform.com/api-reference/introduction.md): Overview of the OpnForm REST API, base URL, authentication, and rate limits.
- [Create Submission](https://docs.opnform.com/api-reference/submissions/create-submission.md): Create a new submission for a form. Public endpoint - no authentication required.
- [Delete Submission](https://docs.opnform.com/api-reference/submissions/delete-submission.md): Requires `forms-write`.
- [Check Export Status](https://docs.opnform.com/api-reference/submissions/export-status.md): Check the status of an asynchronous export job. Requires `forms-read`.
- [Export Submissions (CSV)](https://docs.opnform.com/api-reference/submissions/export-submissions-csv.md): Export submissions as CSV. Large exports are processed asynchronously. Requires `forms-read`.
- [List Submissions](https://docs.opnform.com/api-reference/submissions/list-submissions.md): Requires `forms-read`. Supports pagination, search, and status filtering.
- [Update Submission](https://docs.opnform.com/api-reference/submissions/update-submission.md): Update a submission. Requires `forms-write` ability.
- [Add Workspace User](https://docs.opnform.com/api-reference/workspace-users/add-workspace-user.md): Requires `workspace-users-write`. Add an existing user or send an invite if the email is unknown.
- [Cancel Workspace Invite](https://docs.opnform.com/api-reference/workspace-users/cancel-workspace-invite.md): Requires `workspace-users-write`. Delete a pending invite.
- [Leave Workspace](https://docs.opnform.com/api-reference/workspace-users/leave-workspace.md): Allows the current user to leave the workspace. Requires `workspace-users-write`.
- [List Workspace Invites](https://docs.opnform.com/api-reference/workspace-users/list-workspace-invites.md): Requires `workspace-users-read`. Lists pending & accepted invites.
- [List Workspace Users](https://docs.opnform.com/api-reference/workspace-users/list-workspace-users.md): Requires `workspace-users-read`. Returns members with their role.
- [Remove Workspace User](https://docs.opnform.com/api-reference/workspace-users/remove-workspace-user.md): Requires `workspace-users-write`. Removes a specified user from the workspace.
- [Resend Workspace Invite](https://docs.opnform.com/api-reference/workspace-users/resend-workspace-invite.md): Requires `workspace-users-write`. Resend the invitation email for a pending invite.
- [Update Workspace User Role](https://docs.opnform.com/api-reference/workspace-users/update-workspace-user-role.md): Requires `workspace-users-write`. Update a member's role.
- [Create Workspace](https://docs.opnform.com/api-reference/workspaces/create-workspace.md): Requires `workspaces-write`.
- [Delete Workspace](https://docs.opnform.com/api-reference/workspaces/delete-workspace.md): Permanently delete a workspace. Requires `workspaces-write`.
- [List Workspaces](https://docs.opnform.com/api-reference/workspaces/list-workspaces.md): Requires `workspaces-read`.
- [Update Workspace](https://docs.opnform.com/api-reference/workspaces/update-workspace.md): Update workspace name or icon. Requires `workspaces-write`.
- [List Forms](https://docs.opnform.com/api-reference/zapier/list-forms.md): Retrieve a list of forms available in a specific workspace.
- [New Submission Trigger](https://docs.opnform.com/api-reference/zapier/new-submission-trigger.md): This endpoint is used to set up a webhook for new form submissions.
- [Sample Submission Polling](https://docs.opnform.com/api-reference/zapier/sample-submission-polling.md): Retrieves the most recent submissions for a specified form.
- [Unsubscribe Webhook](https://docs.opnform.com/api-reference/zapier/unsubscribe-webhook.md): This endpoint is used to unsubscribe from the webhook.
- [Validate API Key](https://docs.opnform.com/api-reference/zapier/validate-api-key.md): This endpoint is used by Zapier to test the validity of the API key.
- [AWS S3 Configuration](https://docs.opnform.com/configuration/aws-s3.md): OpnForm & File uploads
- [Using your own domain](https://docs.opnform.com/configuration/custom-domain.md): Setting up a custom domain for OpnForm
- [Disable Two-Factor Authentication](https://docs.opnform.com/configuration/disable-2fa.md): Administrative command to disable two-factor authentication for users
- [Email Setup](https://docs.opnform.com/configuration/email-setup.md): OpnForm & Emails
- [Environment Variables](https://docs.opnform.com/configuration/environment-variables.md): Detailed guide on configuring environment variables for OpnForm
- [OAuth Integration Setup](https://docs.opnform.com/configuration/oauth-setup.md): Complete guide to configuring OAuth integrations for Google, Stripe, and Telegram in OpnForm
- [OIDC SSO Configuration](https://docs.opnform.com/configuration/oidc-sso.md): Complete guide to configuring OpenID Connect Single Sign-On for your workspace
- [Subdomain Redirect](https://docs.opnform.com/configuration/subdomain-redirect.md): Hide OpnForm's public pages by redirecting users to your main website
- [Getting Started](https://docs.opnform.com/contributing/getting-started.md): Learn how to contribute to OpnForm
- [Creating a New Form Block](https://docs.opnform.com/contributing/new-form-block.md): Learn how to create a new form block for OpnForm
- [Adding a New OAuth Integration](https://docs.opnform.com/contributing/new-integration.md): Complete guide to implementing OAuth integrations in OpnForm with architecture overview, flow diagrams, and step-by-step implementation
- [Cloud vs Self-Hosting](https://docs.opnform.com/deployment/cloud-vs-self-hosting.md): Understand the differences between cloud and self-hosting options for OpnForm
- [Docker Deployment](https://docs.opnform.com/deployment/docker.md): Deploy OpnForm using Docker
- [Docker Development Setup](https://docs.opnform.com/deployment/docker-development.md): Set up OpnForm locally for development using Docker
- [Local Deployment](https://docs.opnform.com/deployment/local-deployment.md): Set up OpnForm locally for development
- [Data Fetching](https://docs.opnform.com/front-end/data-fetching.md): How we fetch and mutate server data in the front-end with TanStack Query.
- [Forms & Validation](https://docs.opnform.com/front-end/forms.md): How to build forms with validation, error handling, and API integration using our form system.
- [Introduction to OpnForm](https://docs.opnform.com/introduction.md): An open-source form builder
- [Tech Stack](https://docs.opnform.com/tech-stack.md): Overview of OpnForm's technology stack

## OpenAPI Specs

- [openapi](https://docs.opnform.com/api-reference/openapi.yaml)

## Optional

- [Product Documentation](https://help.opnform.com)
- [Community](https://discord.gg/YTSjU2a9TS)
- [Changelog](https://feedback.opnform.com/changelog)
- [Roadmap](https://feedback.opnform.com/roadmap)