API and Webhooks
Tabs
The API and Webhooks page is where your team manages the tools for connecting PlatoForms to external services: webhook endpoints that push form submissions to other systems, OAuth2 applications for third-party integrations, and long-lived tokens for server-to-server API calls. This chapter walks through how to access the page and configure each of these.
Access the API and Webhooks page
-
Log in to your Dashboard.
-
In the left sidebar, click on your team name to open the team menu.
-
Select API and Webhooks from the list.
What you’ll see based on your permissions
If you have access
The page opens directly to API URL & Tokens, where you can view and manage your webhooks, OAuth2 applications, and tokens.
Team admins always have direct access to this page.
If you don’t have access
API and Webhooks is shown with a lock icon and a “Request access from admin” label.
Click Request access from admin to send a request.
Your team admin receives an email notifying them of the request. Once access is granted, you’ll be able to open API and Webhooks from your own team menu.
Configure Webhook endpoints
Set up endpoints to receive real-time notifications when forms are submitted or other events occur. Useful for integrating form data into other applications or services.
Click + Add endpoint to create a new one, or the edit icon next to an existing endpoint to modify it.
When adding or editing an endpoint, you can configure:
| Field | Description |
|---|---|
| Name | A label to help you identify the endpoint. |
| WebHook URL | The URL that will receive the POST request. |
| Target Form | Choose All Forms to trigger the webhook for any form submission, or select a specific form. |
| Include shareable links | Include shareable submission links in the payload. |
| Submission data as Dict (instead of List) | Change the structure of the submission data in the payload. |
| Instant Hook (No waiting for PDF creation) | Fire the webhook immediately instead of waiting for the submission PDF to finish generating. |
| Exclude signature data from payload | Omit signature data from the payload. |
| Webhook Enabled | Toggle the endpoint on or off without deleting it (available when editing an existing endpoint). |
Click Save to apply your changes, or Delete to remove the endpoint entirely.
Create an OAuth2 Application
PlatoForms’ APIs are safeguarded by the OAuth2 protocol, a secure authentication and authorization framework. An “OAuth2 Application” refers to a registered application utilizing OAuth 2.0 for interaction with the system.
By creating an OAuth2 application, you can securely obtain a Client ID and Client Secret through an authentication process. This, in turn, facilitates the secure authorization of other applications to access the platform’s API. The creation of an ‘OAuth2 Application’ sets up the essential components for secure integration, allowing interactions with the API using OAuth2 for both authentication and authorization.
To create an OAuth2 Application:
-
Click + Add application.
-
In the window that opens:
-
Provide a Name for your application, which helps identify it within the system.
-
Specify a Redirect URL, which is crucial for the OAuth2 flow.
-
-
Confirm your settings by clicking Save.
Once the application is saved, the system generates a unique Client ID and a Client Secret.
Create and reset your token
If you are a developer requiring prolonged API access, the platform offers the capability to create and reset your team’s Non-expiry Token. This feature eliminates the need for regular token refresh, ensuring uninterrupted and extended API access for server-to-server requests. Each team has a single non-expiry token.
Simply click Create or reset to generate the token, and use Delete to remove it when needed. This functionality streamlines the process of managing long-term access to the API.
Treat tokens, Client IDs, and Client Secrets like passwords. Anyone with access to them can access your team’s data.