FormWise Manual
Your FormWise Dashboard
  • Welcome
  • Book a 1-on-1 Onboarding Session
  • Core Features
    • Your Dashboard
    • OpenAI API Key
    • SmartForms
    • CoPilots
    • Toolsets
    • Login Mode & Monetization
      • Choose A Toolset To Monetize
      • Setting Up Stripe Payments
      • Setting Up Subscription Plans
      • Embedding Your Login Mode Toolset
      • What Your Users See
      • Login Mode FAQs
      • Creating Credit Add Ons
      • Customizing Your Tool's Credit Usage
      • Using Coupon Codes
      • Editing Default Text And Internationalization
      • Migrating Existing Users
      • Importing Your FormWise AI Tool SaaS Templates
      • Using Webhooks For Login Mode User Sign Ups
      • Login Mode Stripe FAQs
    • OpenAI's GPT Engines Overview
  • Full Features
    • Intro To Prompt Chaining in FormWise
    • Advanced Prompt Chaining Guide
    • Using Front-End File Uploads in SmartForms
    • Using Backend Data Sources in SmartForms
    • Using Backend Data Sources in CoPilots
    • Using Front-End File Uploads in CoPilots
    • Web Searching
    • Web Crawling
    • Cached Input Responses (Toolsets)
    • Using Toolset Starter Packs
      • 📢 Digital Marketing Accelerator - Toolset Starter Pack
      • 🏪eCommerce A.I. Toolkit - Toolset Starter Pack
      • 📚 Blog Writing & SEO Toolkit – Toolset Starter Pack
      • 📚 Email Marketing Power Pack – Toolset Starter Pack
      • 📚 Course Creator’s Toolkit – Toolset Starter Pack
      • 📚 Real Estate Agent Success Toolkit – Toolset Starter Pack
      • 📚 Author & Writer A.I. Kit – Toolset Starter Pack
    • Sharing & Adding Toolsets
    • Auto Populate Fields In Your Tool URLs
    • Collaborators & Workspaces
    • Brand Voice Profile Settings
  • Using FormWise & HighLevel
    • HighLevel & FormWise
    • Full HighLevel Agency Plan Setup & Integration
    • Sending FormWise AI Responses to HighLevel Workflows via Webhook
  • Free Resources
    • Activate HighLevel CRM Subaccount
      • Activation Link
      • HighLevel CRM Training Tutorials
    • Use Case Guides
      • GUIDE: CoPilot Best Practices
      • GUIDE: Building Your AI Tool in Seconds with FormWise’s AI Tool Wizard
      • GUIDE: Building a Course Companion CoPilot in FormWise
      • GUIDE: Building a Niche-Specific AI Toolkit for Your GoHighLevel SaaS
      • GUIDE: How to Embed FormWise CoPilots and SmartForms in GoHighLevel Membership or Course Areas
      • GUIDE: Turning Responses Into PDFs
    • Use Case Examples
      • Quick Guides
        • Building A Simple A.I. Tool
        • Building A Chatbot CoPilot
        • Building An A.I. Lead Magnet
        • Building An A.I. Quiz
        • Building An A.I. Toolset
      • Generate A.I. Tool Ideas Here
      • Embedded Tool Examples
      • Watch Me Build
    • CoPilot Prompt Templates
      • ✈️Travel Assistant CoPilot Prompt
      • 📙Course Creator CoPilot Prompt
      • ✉️Email Responder Coach CoPilot Prompt
      • 👜Small Business Plan Coach CoPilot Prompt
      • 📘Facebook Ads Copy Coach CoPilot
      • 🔍SEO Article CoPilot Prompt
      • 📜Resume Coach CoPilot Prompt
      • 💌Email Copy Coach CoPilot Prompt
      • 📈GoHighLevel Coach CoPilot Prompt
      • 🥇UVP Coach CoPilot
      • 💪Fitness Coach CoPilot Prompt
      • 🔢Quiz Creator CoPilot Prompt
      • 📜Working with Transcripts CoPilot Prompt
    • SmartForm Builder GPT
    • CoPilot Builder GPT
  • SUPPORT
    • Account & Billing
    • Support & Office Hours Registration
    • Troubleshooting Errors
      • Page Load Errors
      • Error 500 Troubleshooting
      • Tools Stuck At 75%
      • Form Submission Errors
    • FAQs
    • What’s the Difference Between the Pro and Agency Plans?
  • Integrations
    • OpenAI
    • OpenAI Documentation
    • FormWise API
      • POST a Form Completion to Formwise
      • GET a Form Completion from FormWise
      • Form Completion Webhooks
        • Parsing Responses for Zapier
    • Kajabi
      • How to Send FormWise Lead Data into Kajabi using Webhooks
      • How to Embed FormWise CoPilots and SmartForms into Your Kajabi Course
    • Teachable
      • How to Embed FormWise CoPilots and SmartForms in Teachable
    • Circle.so
    • Third Party Platform Embedding
      • WordPress (Embedding Tools)
      • Webflow (Embedding Tools)
      • Wix (Embedding Tools)
      • Squarespace (Embedding Tools)
      • Bubble.io (Embedding Tools)
Powered by GitBook
On this page

Was this helpful?

  1. Integrations
  2. FormWise API

Using The FormWise API

The Data API lets send form responses from third party form builders that can be executed using your form, as if it was filled out traditionally on FormWise.

Last updated 6 months ago

Was this helpful?

Form Completion

POST a Form Completion to Formwise

Headers

Name
Type
Description

Authorization*

Bearer <YOUR-KEY>

Your API Token which can be found on the Account page

Request Body

Name
Type
Description

form_id*

"1679493702554x213757137604050940"

The Live Form ID of the Form you are processing the responses with.

answer_array*

["Yes","No","Maybe","Certainly","Unsure"]

An array of answers which represent the form response. Ensure the order of the answers matches the order of the questions on your form. Example: ["Yes","No","Maybe","Certainly","Unsure"]

After a successful POST, you will see the form response within your Live form responses. You will also receive your own email which is used to reference the account when using Zapier.

Example Response

{
    "Response ID": "1689116584424x991255285110145000"
}

Retrieve Response

Retrieve Response request is used when you want to retrieve the results of a form submission.

GET a Response Result from Formwise

GET https://app.formwise.ai/api/1.1/wf/retrieve_response/ID=<response id>

Making this GET request will request the results of a response. The Formwise API is async so we recommend waiting for the content to generate before initiating this API call as you will receive an error otherwise.

Path Parameters

Name
Type
Description

ID*

Object

Headers

Name
Type
Description

Authorization*

Bearer <YOUR-KEY>

Your API Token which can be found on the Account page

Retrieve Form IDs

The Retrieve Form IDs request is used when you want to retrieve a list of your Form IDs for use in subsequent API calls. This API is not entirely required as you can always copy the Form ID from the URL once you share your Live form within your Dashboard or on the Form Builder.

GET all Form IDs

GET https://app.formwise.ai/api/1.1/wf/form_retrieval

This operation will retrieve your Live forms in pagination (25 at once) form.

Headers

Name
Type
Description

Authorization*

Bearer <YOUR-KEY>

Your API Token which can be found on the Account page

After a successful GET, you will receive an array of your Live Forms along with their ID which is necessary for a Form Completion, along with its Title in the event you want to store this ID and want to reference it later.

Example Response

[ 
  {
    "_id": "1679493702554x213757137604050940",
    "title": "Marketing Feedback Form"
    },
  {
    "_id": "1679493702554x994703839005245400",
    "title": "Facebook Ad Generator"
    }
]

Errors

The Data API runs on certain conditions which may throw errors when you try to Upload form data or Retrieve information about your forms. The most common error will be a 400 Error. There a few things this could mean and ways to remedy them.

  • Your Monthly Quota has been exceeded and you cannot process any additional Form Responses.

    • Upgrade your account to a higher tiered plan.

  • You are using a Preview Form ID when it should be a Live Form ID.

  • Your Account is Locked due to a subscription cancellation.

    • Update your account standing by navigating to the home page and updating your payment settings.

Not returning a Response but no error

If you are not receiving a response upon Form submission, it is possible that the form ID you provided was not created by the user whose account Token is associated with the API call. If you are a collaborator, we recommend using the Token of the Parent account of your organization.

The ID of the response returned from the call. Ensure there are no quotes around the ID.

Use the and select a Form or Share a form on your dashboard and copy the ID from the URL.

Retrieve Form ID GET request
Form Completion API
  • Form Completion
  • POST a Form Completion to Formwise
  • POSTPost a form completion
  • Retrieve Response
  • GET a Response Result from Formwise
  • Retrieve Form IDs
  • GET all Form IDs
  • Errors
  • Not returning a Response but no error

Post a form completion

post

Sending a form to this endpoint will process as it would a traditional Formwise form submission.

Authorizations
Body
form_idstringRequired

The Live Form ID of the Form you are processing the responses with.

answer_arraystring[]Required

An array of answers which represent the form response. Ensure the order of the answers matches the order of the questions on your form.

Responses
200
OK: Returns the Response ID of the submitted form.
application/json
400
Bad Request: See Errors Below
post
POST /api/1.1/wf/form_completion HTTP/1.1
Host: app.formwise.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "form_id": "text",
  "answer_array": [
    "text"
  ]
}
{
  "Response_ID": "1689116584424x9912552851101456000"
}