Back

WPForms API Essential Guide

Aug 11, 20246 minute read

What type of API does WPForms provide?

Based on the search results provided, it does not appear that WPForms has a specific API type like REST, GraphQL, or SOAP mentioned. The search results do not contain any direct information about WPForms' API.

However, we can make some inferences based on the context:

  1. WPForms is mentioned alongside other WordPress plugins and form builders like Gravity Forms.

  2. WordPress itself uses a REST API as its primary API type.

  3. There are plugins available that allow integration of external APIs, including REST APIs, with WordPress forms.

Key points to consider:

  • WordPress ecosystem: Since WPForms is a WordPress plugin, it's likely that if it has an API, it would follow WordPress conventions.
  • WordPress REST API: WordPress core uses a REST API, so many plugins also adopt this approach for consistency.
  • No specific mention: The lack of specific information about WPForms API in the search results suggests it may not have a widely publicized or used API.

While we can't definitively state what type of API WPForms uses based on the given information, if it does have an API, it's most likely to be a REST API to align with WordPress standards. However, to get an accurate answer, you would need to check WPForms' official documentation or contact their support directly.

Does the WPForms API have webhooks?

Does WPForms have webhooks?

Yes, WPForms offers webhook functionality through its Webhooks addon.

Key points about WPForms webhooks:

  • The Webhooks addon is available with the Elite license level.
  • It allows sending form entry data to external tools and services.
  • No coding is required to set up webhooks.
  • It can be an alternative to using connector services like Zapier.

Types of events/triggers:

Webhooks can be triggered by form submissions. Some potential triggers include:

  • New form submissions
  • Form abandonment
  • Specific field entries (using conditional logic)

Webhook configuration options:

  • Request Method: GET, POST, PUT, PATCH, DELETE
  • Request Format: JSON
  • Request Headers: Can be customized
  • Request Body: Can specify keys and values to send
  • Conditional Logic: Can trigger webhooks based on specific form inputs

Best practices:

  • Use Smart Tags to dynamically insert information into headers and body
  • Test webhooks thoroughly before publishing forms
  • Consider security implications when sending sensitive data

In summary, WPForms provides robust webhook functionality that allows connecting forms to external services without coding, with options for customization and conditional triggering. The main event type is form submissions, but specific fields or conditions can be used to refine webhook triggers.

Rate Limits and other limitations

Based on the search results provided, there is no specific information about API rate limits for the WPForms API. However, I can provide some general information about API rate limits and best practices:

Key Points About API Rate Limits

  1. API rate limits are restrictions on the number of requests a client can make to an API within a certain time period [1].

  2. Rate limits help prevent abuse and ensure fair usage of API resources [1].

  3. Common rate limit implementations include:

    • Requests per hour (e.g. 500 requests per hour) [1]
    • Requests per day (e.g. 10,000 requests per day) [5]
  4. Rate limits often vary based on the type of account or subscription level [5].

Best Practices for Handling API Rate Limits

  1. Check API documentation for specific rate limit information.

  2. Monitor rate limit headers in API responses to track remaining requests [1].

  3. Implement backoff and retry logic when rate limits are reached.

  4. Consider caching API responses to reduce the number of requests needed.

  5. Optimize API usage by batching requests when possible.

Example Rate Limit Structure

While not specific to WPForms, here's an example of how API rate limits might be structured based on plan levels [5]:

  • Free tier: 1,000 requests per day
  • Basic paid tier: 10,000 requests per day
  • Premium tier: 50,000 requests per day
  • Enterprise tier: 100,000 requests per day

Summary

Without specific information about WPForms API rate limits, it's best to consult their official documentation or contact their support for accurate details. In general, be prepared to implement rate limit handling in your code and consider upgrading to higher tier plans if you need increased API access.

Latest API Version

Based on the search results provided, here are the key points about the most recent version of the WPForms API:

Most Recent Version

The most recent version of WPForms mentioned in the search results is 1.8.2.2, released on June 28, 2023.

Key Changes in Recent Versions

Some notable changes and additions in recent WPForms versions include:

  • Added compatibility with the WPForms Coupons addon
  • Added a new hook for developers that fires when a form is duplicated
  • Fixed various issues related to Stripe integration, form challenges, file uploads, and more
  • Improved compatibility with plugins like Popup Maker
  • Added support for multiple select options in Dropdown fields (version 1.6.1)
  • Added a new Modern style option for Dropdown and Payment Dropdown fields (version 1.6.1)
  • Improved integration with the WP Mail SMTP plugin (version 1.7.6)
  • Updated the intl-tel-input library to support more regions and area codes (version 1.7.6)

Discontinued Support

It's worth noting that support for older PHP and WordPress versions has been discontinued in recent updates:

  • Support for PHP 5.5 was discontinued in version 1.7.3
  • Support for WordPress 5.1 was discontinued in version 1.7.3
  • Support for PHP 5.4 was discontinued in version 1.5.9
  • Support for PHP 5.3 was discontinued in version 1.5.6

Best Practices

To ensure compatibility and access to the latest features, it's recommended to:

  1. Keep WPForms updated to the latest version
  2. Maintain an up-to-date WordPress installation
  3. Use a supported PHP version (currently PHP 5.6 or higher based on the information provided)

How to get a WPForms developer account and API Keys?

Here are the key steps to get a developer account for WPForms to create an API integration:

  1. You'll need an Elite license level for WPForms to access the API and integration capabilities.

  2. Ensure you have the latest version of WPForms installed and activated on your WordPress site.

  3. Verify your WPForms license in your WordPress admin.

  4. Install and activate the relevant addon for the integration you want to create (e.g. Salesforce addon, Webhooks addon).

  5. For integrations with specific services like Salesforce:

    • Create a developer account with that service (e.g. Salesforce Developer account)
    • Create a new connected app in your developer account
    • Configure OAuth settings and permissions
    • Get API credentials like Consumer Key and Secret
  6. In your WPForms settings, connect to the service using the API credentials.

  7. Add the integration to your specific form and map form fields to the service fields.

  8. Test the integration by submitting the form and verifying the data is sent correctly.

What can you do with the WPForms API?

Based on the search results provided, here is a list of data models you can interact with using the WPForms API, along with what is possible for each:

Forms

  • Create, read, update, and delete forms
  • Access form fields and settings
  • Apply conditional logic to form fields
  • Create multi-page forms
  • Add file upload capabilities
  • Implement form abandonment tracking
  • Create conversational forms
  • Generate form landing pages

Form Entries

  • Collect and store form submissions
  • Access and manage form entry data
  • Apply entry management features like search, filter, etc.
  • Export entries

Fields

  • Add, modify, and remove form fields
  • Access field properties and settings
  • Implement advanced fields like signature, repeater fields, etc.
  • Apply conditional logic to fields

Notifications

  • Set up and manage form notifications
  • Configure multiple notifications per form
  • Use smart tags in notifications

Confirmations

  • Create and manage form confirmation messages/pages
  • Set up conditional confirmations

Payments

  • Process payments via integrations like Stripe, PayPal, Square, Authorize.Net
  • Manage payment forms and transactions
  • Implement features like coupons, calculations, etc.

Integrations

  • Connect forms to email marketing services, CRMs, etc.
  • Set up webhooks to send data to external services
  • Integrate with services like Slack, Google Sheets, etc.

User Registration

  • Create and manage user registration forms
  • Handle user account creation and management

Surveys & Polls

  • Create survey and poll forms
  • Access and analyze survey/poll results

Form Analytics

  • Access form conversion data
  • Generate reports on form performance and user journeys

This covers the main data models and capabilities exposed through the WPForms API based on the provided search results. The API allows extensive interaction with forms, entries, fields, and various form-related features and integrations.