123FormBuilder API Essential Guide

What type of API does 123FormBuilder provide?

Based on the search results provided, 123FormBuilder appears to have a REST API. The API documentation mentions making HTTP GET and POST requests to specific endpoints, which is characteristic of REST APIs. The API uses URL structures like "https://app.123formbuilder.com/api/forms/{form-id}/submissions.{xml/json}", which follows REST conventions of using resources in the URL path. The API supports both XML and JSON output formats, which are common for REST APIs. The API uses standard HTTP methods like GET and POST, another hallmark of REST APIs.

Does the 123FormBuilder API have webhooks?

Webhook Support

123FormBuilder does support webhooks as part of their API functionality.

How Webhooks Work

• Webhooks allow you to send submitted form data from your 123FormBuilder account to a custom script on your own server.
• You provide the URL where your script is located in the "Script URL" box when setting up the webhook.
• The system creates an HTTP HEAD request to validate the URL when you add it.

Events You Can Subscribe To

The main event appears to be form submissions - webhooks allow you to receive data when a form is submitted.

Setting Up Webhooks

1. Add the URL of your script in the "Script URL" box in the webhook application settings.
2. You can map form fields to variables in your script using the "Customize" option.
3. Ensure your script supports HTTP HEAD requests for validation.

Limitations

• You cannot link more than ten webhook applications to a single form.

API Endpoint

The API endpoint for adding webhooks is:

https://app.123formbuilder.com/api/forms/[FORM ID]/webhooks.xml?apiKey=[API KEY]&webhookUrl=[YOUR URL]

This performs the same function as adding a webhook through the UI.

Additional Notes

• Webhook requests are sent via HTTPS only.
• You'll receive a confirmation message when a webhook is added successfully.
• The API documentation mentions a newer API v2 that may have updated webhook functionality.

Rate Limits and other limitations

Here are the key points about the API rate limits for 123FormBuilder:

API Call Limits

• On the Basic (free) plan, 123FormBuilder allows 100 API calls per day.

• The API call limit resets at midnight Eastern Standard Time (EST) each day.

What Happens When Limits Are Exceeded

• If you exceed the API call limit, you will receive an error message stating "You have exceeded the number of requests for today!"

• Exceeding the limit may cause certain integrations or services that rely on the API to stop working properly.

How to Check Remaining Calls

• 123FormBuilder does not appear to provide a way to check remaining API calls directly.

• However, you can monitor API usage by checking the response headers, which include information on rate limits and remaining requests.

Key Considerations

• The 100 calls per day limit on the Basic plan is quite restrictive compared to other form builders. For example, Jotform offers 1,000 daily API calls on their free plan.

• If you need more API calls, you would need to upgrade to a paid 123FormBuilder plan.

• Enterprise plans may offer higher or unlimited API call limits, but you would need to contact 123FormBuilder sales for details.

Best Practices

• Monitor your API usage closely to avoid hitting limits unexpectedly.

• Consider upgrading plans if you consistently hit the API limit.

• Optimize your API calls to use them efficiently within the given limits.

In summary, 123FormBuilder has fairly strict API rate limits on their Basic plan. If you require extensive API usage, you may need to consider a paid plan or alternative form builder with more generous limits.

Latest API Version

Based on the search results provided, here is the answer to your question:

Most Recent Version of 123FormBuilder API

The most recent version of the 123FormBuilder API is API v2.

Key points to consider:

• API v2 is described as "much more robust, fast, and easy to use" compared to the previous version.

• All actions in API v2 are done using tokens, which can be easily generated or invalidated.

• There are two endpoints for API v2, depending on where your account was created:

  • For accounts created on the main site: https://api.123formbuilder.com/v2/
  • For accounts created on the EU site: https://eu-api.123formbuilder.com/v2/

• The previous version of the API (v1) has been deprecated.

Additional Information

• To use the API, you need an API key, which can be found in your 123FormBuilder account under "My Account" → "API Keys".

• The number of API calls per day is limited based on your account plan. A Basic free account can perform up to 100 API calls per day.

• For more advanced capabilities, it is highly recommended to use API v2.

• Documentation for the new API v2 can be found on the 123FormBuilder developer documentation site.

In summary, API v2 is the most recent and recommended version of the 123FormBuilder API, offering improved functionality and ease of use compared to the deprecated v1.

How to get a 123FormBuilder developer account and API Keys?

To get a developer account for 123FormBuilder to create an API integration, you'll need to follow these steps:

1. Sign up for a 123FormBuilder account:

   • Go to the 123FormBuilder website and create an account if you don't already have one.

2. Upgrade to a paid plan:

   • API access is typically available on paid plans like Gold, Platinum, or Diamond.
   • A Basic free account can only perform up to 100 API calls per day, while paid plans offer unlimited API calls.

3. Generate an API key:

   • Log in to your 123FormBuilder account.
   • Click on your username and select "API Keys" from the dropdown menu.
   • If an API key is not displayed, click on the "Create now" link to generate one.

4. Access the API documentation:

   • Visit the 123FormBuilder developer documentation to learn about the available API endpoints and how to use them.

5. Start integrating:

   • Use the API key in your API requests to authenticate and access the 123FormBuilder API.

What can you do with the 123FormBuilder API?

Based on the search results, here are the key data models you can interact with using the 123FormBuilder API, along with what is possible for each:

Forms

• Retrieve forms [1]
• Get form details and structure [1]
• Create new forms (implied by "Form Created" trigger) [3]

Form Fields

• Retrieve fields for a specific form [1]

Form Submissions

• Retrieve submissions for a form [1]
• Get submission count for a form [1]
• Access submitted form data in real-time [3]

Webhooks

• Add webhooks to forms [2]
• Manage up to 10 webhooks per form [2]

Users

• Retrieve user information [3]

Key capabilities:

• Automate data collection processes [4]
• Retrieve collected data [4]
• Perform various operations related to your 123FormBuilder account [4]
• Real-time access to form submissions [3]
• Update form structures programmatically [3]
• Manage respondents and their submissions [3]

Limitations:

• Basic free accounts are limited to 100 API calls per day [1]
• Webhooks are limited to 10 per form [2]

The API allows for comprehensive interaction with forms, submissions, and account data, enabling automation of many form management and data collection tasks. However, there are some usage limits, especially for free accounts.