2024-06-18 – API creation 🎉

Changelog

OpnForm Technical Docs

Introduction to OpnForm

Tech Stack

Docker Deployment

Set up OpnForm locally for development using Docker

Docker Development Setup

Local Deployment

Understand the differences between cloud and self-hosting options for OpnForm

Cloud vs Self-Hosting

Detailed guide on configuring environment variables for OpnForm

Environment Variables

AWS S3 Configuration

Email Setup

Using your own domain

Hide OpnForm's public pages by redirecting users to your main website

Subdomain Redirect

Overview of the OpnForm REST API, base URL, authentication, and rate limits.

Introduction

Generate and manage Personal Access Tokens on OpnForm.

API Keys

List Workspaces

Create Workspace

Update workspace name or icon. Requires `workspaces-write`.

Update Workspace

Permanently delete a workspace. Requires `workspaces-write`.

Delete Workspace

Requires `workspace-users-read`. Returns members with their role.

List Workspace Users

Requires `workspace-users-read`. Lists pending & accepted invites.

List Workspace Invites

Requires `workspace-users-write`. Add an existing user or send an invite if the email is unknown.

Add Workspace User

Requires `workspace-users-write`. Removes a specified user from the workspace.

Remove Workspace User

Requires `workspace-users-write`. Update a member's role.

Update Workspace User Role

Allows the current user to leave the workspace. Requires `workspace-users-write`.

Leave Workspace

Requires `workspace-users-write`. Resend the invitation email for a pending invite.

Resend Workspace Invite

Requires `workspace-users-write`. Delete a pending invite.

Cancel Workspace Invite

Retrieve all forms accessible to the token holder.

List Forms

Create a new form; requires forms-write ability.

Create Form

Get Form

Update an existing form. Requires `forms-write`.

Update Form

Delete Form

Requires `forms-read`. Supports pagination via the `page` query parameter.

List Submissions

Export submissions as CSV. Requires `forms-read`.

Export Submissions (CSV)

Update a submission. Requires `forms-write` ability.

Update Submission

Delete Submission

This endpoint is used by Zapier to test the validity of the API key.

Validate API Key

Retrieve a list of forms available in a specific workspace.

This endpoint is used to set up a webhook for new form submissions.

New Submission Trigger

This endpoint is used to unsubscribe from the webhook.

Unsubscribe Webhook

Retrieves the most recent submissions for a specified form.

Sample Submission Polling

Getting Started

Learn how to create a new form block for OpnForm

Creating a New Form Block

Learn how to add a new integration to OpnForm

Overview

Workspaces

Workspace Users

Forms

Submissions

Zapier

​2024-06-18 – API creation 🎉

2024-06-18 – API creation 🎉