Jotform

Jotform Connection

Put Jotform to Work with @Human Automations and @Human Agents

The Jotform Connection documents all Triggers, Actions and Query Operations available for creating automations via the Jotform API.

What can you do with the Jotform Connection?

• Connect to the Jotform API in a few clicks

• Use the related Jotform Operations (see below) in @Human Automations or @Human Agents

Related Operations

Trigger Operations

Submission Created

Triggers on: submissions/submission_created

Triggered when a new form submission is received in Jotform.

Action Operations

Action: Assign Form

Action: Create Submission

Action: Assign Prefilled Form

Action: API Request

Query Operations

Example link

Related Automations

Example link

Obtaining Access Credentials

To obtain a System-to-System Personal Access Token (PAT) for Jotform, follow these steps:

Required Values

1. Jotform Account (Free or Paid)

2. Jotform API Key (Generated via UI)

Step-by-Step Guide

1. Log in to Jotform

• Go to Jotform and log in with your account.

2. Navigate to API Settings

• Click your profile icon (top-right) → Settings → API.

3. Generate an API Key

• Under API Key, click Create New Key.

• Enter a name (e.g., "System-to-System Access").

• Select Full Access (or restrict scopes as needed).

• Click Generate Key.

4. Copy the API Key

• The generated key will appear once—copy it immediately.

• This key acts as your Personal Access Token (PAT).

Done. Use this key for system-to-system authentication.

Configuring Webhooks

1. Log in to Jotform

• Go to Jotform and open the form you want to use.

2. Navigate to Settings

• In the top orange navigation bar, click on Settings.

3. Access Integrations

• In the left-hand menu, click on Integrations.

4. Select Webhooks

• Search for Webhooks and click the icon.

5. Add Webhook Endpoint

• In the Add WebHook field, enter your webhook endpoint URL.

• Click Complete Integration.

6. Finish Setup

• Click Finish.

Code (Apache v2.0): Service Connectivity and Metadata

{
  "handle": "jotform-v1",
  "status": "active",
  "meta": {
    "short": "Jotform",
    "description": "Connect to Jotform to manage forms, submissions, and reports.",
    "icon": "jotform",
    "tags": ["forms", "survey", "data collection"]
  },
  "service": {
    "baseURL": {
      "value": "https://api.jotform.com"
    },
    "protocol": "https",
    "contentType": "application/json",
    "headers": {
      "APIKEY": {
        "value": "{{apiKey}}"
      }
    },
    "auth": {
      "method": "api_token",
      "params": {
        "apiToken": {
          "token": {
            "value": "{{apiKey}}"
          },
          "headerName": {
            "value": "APIKEY"
          }
        }
      }
    }
  }
}

Code (Apache v2.0): List of External Resources and Internal Mapping

[
  {
    "handle": "user",
    "meta": {
      "short": "User",
      "description": "Manage user details, usage, settings, and history."
    },
    "endpoint": "/user",
    "fields": [
      {
        "name": "username",
        "type": "String",
        "selector": [
          "username"
        ],
        "meta": {
          "description": "Username of the account."
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Full name of the user."
        }
      },
      {
        "name": "email",
        "type": "String",
        "selector": [
          "email"
        ],
        "meta": {
          "description": "Email address associated with the account."
        }
      },
      {
        "name": "account_type",
        "type": "String",
        "selector": [
          "account_type"
        ],
        "meta": {
          "description": "Type of Jotform account."
        }
      },
      {
        "name": "time_zone",
        "type": "String",
        "selector": [
          "time_zone"
        ],
        "meta": {
          "description": "User's timezone."
        }
      }
    ],
    "operations": {
      "read": {
        "method": "GET",
        "path": "",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "usage": {
        "method": "GET",
        "path": "/usage",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "settings_read": {
        "method": "GET",
        "path": "/settings",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "settings_update": {
        "method": "POST",
        "path": "/settings",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"settings\": {{settings}}}",
        "placeholders": [
          {
            "name": "settings",
            "type": "Object",
            "description": "User settings object.",
            "required": true
          }
        ]
      },
      "history": {
        "method": "GET",
        "path": "/history",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      }
    }
  },
  {
    "handle": "forms",
    "meta": {
      "short": "Forms",
      "description": "Manage and retrieve form data including forms structure."
    },
    "endpoint": "/form",
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the form."
        }
      },
      {
        "name": "username",
        "type": "String",
        "selector": [
          "username"
        ],
        "meta": {
          "description": "Username of the form creator."
        }
      },
      {
        "name": "title",
        "type": "String",
        "selector": [
          "title"
        ],
        "meta": {
          "description": "Title of the form."
        }
      },
      {
        "name": "height",
        "type": "String",
        "selector": [
          "height"
        ],
        "meta": {
          "description": "Height of the form."
        }
      },
      {
        "name": "status",
        "type": "String",
        "selector": [
          "status"
        ],
        "meta": {
          "description": "Status of the form (e.g., ENABLED, DELETED)."
        }
      },
      {
        "name": "created_at",
        "type": "String",
        "selector": [
          "created_at"
        ],
        "meta": {
          "description": "Date and time when the form was created."
        }
      },
      {
        "name": "updated_at",
        "type": "String",
        "selector": [
          "updated_at"
        ],
        "meta": {
          "description": "Date and time when the form was last updated."
        }
      },
      {
        "name": "url",
        "type": "String",
        "selector": [
          "url"
        ],
        "meta": {
          "description": "URL of the form."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "/user/forms",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "read": {
        "method": "GET",
        "path": "/form/{{id}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the form to retrieve.",
            "required": true
          }
        ]
      },
      "create": {
        "method": "POST",
        "path": "/user/forms",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"properties\": {{properties}}, \"questions\": {{questions}}, \"emails\": {{emails}}}",
        "placeholders": [
          {
            "name": "properties",
            "type": "Object",
            "description": "Form properties.",
            "required": false
          },
          {
            "name": "questions",
            "type": "Array",
            "description": "Form questions.",
            "required": false
          },
          {
            "name": "emails",
            "type": "Array",
            "description": "Form emails.",
            "required": false
          }
        ]
      },
      "update": {
        "method": "POST",
        "path": "/form/{{id}}",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"properties\": {{properties}}}",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the form to update.",
            "required": true
          },
          {
            "name": "properties",
            "type": "Object",
            "description": "Updated form properties.",
            "required": true
          }
        ]
      },
      "delete": {
        "method": "DELETE",
        "path": "/form/{{id}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the form to delete.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "submissions",
    "meta": {
      "short": "Submissions",
      "description": "Retrieve and manage form submissions."
    },
    "endpoint": "/submission",
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the submission."
        }
      },
      {
        "name": "form_id",
        "type": "String",
        "selector": [
          "form_id"
        ],
        "meta": {
          "description": "ID of the form associated with the submission."
        }
      },
      {
        "name": "ip",
        "type": "String",
        "selector": [
          "ip"
        ],
        "meta": {
          "description": "IP address from which the submission was made."
        }
      },
      {
        "name": "created_at",
        "type": "String",
        "selector": [
          "created_at"
        ],
        "meta": {
          "description": "Date and time when the submission was created."
        }
      },
      {
        "name": "status",
        "type": "String",
        "selector": [
          "status"
        ],
        "meta": {
          "description": "Status of the submission."
        }
      },
      {
        "name": "new",
        "type": "String",
        "selector": [
          "new"
        ],
        "meta": {
          "description": "Indicates if the submission is new (unread)."
        }
      },
      {
        "name": "flag",
        "type": "String",
        "selector": [
          "flag"
        ],
        "meta": {
          "description": "Submission flag (e.g., 0 for unflagged, 1 for flagged)."
        }
      },
      {
        "name": "notes",
        "type": "String",
        "selector": [
          "notes"
        ],
        "meta": {
          "description": "Notes added to the submission."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "/user/submissions",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "list_by_form": {
        "method": "GET",
        "path": "/form/{{form_id}}/submissions",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form to list submissions for.",
            "required": true
          }
        ]
      },
      "read": {
        "method": "GET",
        "path": "/submission/{{id}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the submission to retrieve.",
            "required": true
          }
        ]
      },
      "update": {
        "method": "POST",
        "path": "/submission/{{id}}",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"submission\": {{submission}}}",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the submission to update.",
            "required": true
          },
          {
            "name": "submission",
            "type": "Object",
            "description": "Object containing questions and answers.",
            "required": true
          }
        ]
      },
      "delete": {
        "method": "DELETE",
        "path": "/submission/{{id}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the submission to delete.",
            "required": true
          }
        ]
      }
    },
    "webhooks": [
      {
        "event": "submission_created",
        "path": "/webhooks/jotform/submission-created",
        "payload": [
          {
            "name": "submission_id",
            "type": "String",
            "selector": [
              "submissionID"
            ],
            "meta": {
              "description": "The ID of the submission that was created."
            }
          },
          {
            "name": "form_id",
            "type": "String",
            "selector": [
              "formID"
            ],
            "meta": {
              "description": "The ID of the form associated with the submission."
            }
          }
        ]
      }
    ]
  },
  {
    "handle": "questions",
    "meta": {
      "short": "Questions",
      "description": "Manage questions for a specific form."
    },
    "endpoint": "/form/{{form_id}}/question",
    "fields": [
      {
        "name": "qid",
        "type": "String",
        "selector": [
          "qid"
        ],
        "meta": {
          "description": "Unique identifier for the question."
        }
      },
      {
        "name": "type",
        "type": "String",
        "selector": [
          "type"
        ],
        "meta": {
          "description": "Type of the question (e.g., control_textbox, control_radio)."
        }
      },
      {
        "name": "text",
        "type": "String",
        "selector": [
          "text"
        ],
        "meta": {
          "description": "Question text."
        }
      },
      {
        "name": "order",
        "type": "String",
        "selector": [
          "order"
        ],
        "meta": {
          "description": "Order of the question in the form."
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Internal name of the question field."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "/form/{{form_id}}/questions",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          }
        ]
      },
      "create": {
        "method": "POST",
        "path": "/form/{{form_id}}/questions",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"question\": {{question}}}",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "question",
            "type": "Object",
            "description": "Properties for the new question.",
            "required": true
          }
        ]
      },
      "read": {
        "method": "GET",
        "path": "/form/{{form_id}}/question/{{qid}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "qid",
            "type": "String",
            "description": "The ID of the question.",
            "required": true
          }
        ]
      },
      "update": {
        "method": "POST",
        "path": "/form/{{form_id}}/question/{{qid}}",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"question\": {{question}}}",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "qid",
            "type": "String",
            "description": "The ID of the question.",
            "required": true
          },
          {
            "name": "question",
            "type": "Object",
            "description": "Updated properties for the question.",
            "required": true
          }
        ]
      },
      "delete": {
        "method": "DELETE",
        "path": "/form/{{form_id}}/question/{{qid}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "qid",
            "type": "String",
            "description": "The ID of the question.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "properties",
    "meta": {
      "short": "Properties",
      "description": "Manage form properties."
    },
    "endpoint": "/form/{{form_id}}/properties",
    "fields": [
      {
        "name": "title",
        "type": "String",
        "selector": [
          "title"
        ],
        "meta": {
          "description": "Title of the form."
        }
      },
      {
        "name": "height",
        "type": "String",
        "selector": [
          "height"
        ],
        "meta": {
          "description": "Height of the form."
        }
      },
      {
        "name": "status",
        "type": "String",
        "selector": [
          "status"
        ],
        "meta": {
          "description": "Status of the form."
        }
      }
    ],
    "operations": {
      "read": {
        "method": "GET",
        "path": "",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          }
        ]
      },
      "update": {
        "method": "POST",
        "path": "",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"properties\": {{properties}}}",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "properties",
            "type": "Object",
            "description": "Updated form properties.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "webhooks",
    "meta": {
      "short": "Webhooks",
      "description": "Manage webhooks for a specific form."
    },
    "endpoint": "/form/{{form_id}}/webhooks",
    "fields": [
      {
        "name": "webhookURL",
        "type": "String",
        "selector": [
          "webhookURL"
        ],
        "meta": {
          "description": "The URL of the webhook."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          }
        ]
      },
      "create": {
        "method": "POST",
        "path": "",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": "{\"webhookURL\": \"{{webhookURL}}\"}",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "webhookURL",
            "type": "String",
            "description": "The URL for the webhook.",
            "required": true
          }
        ]
      },
      "delete": {
        "method": "DELETE",
        "path": "/form/{{form_id}}/webhook/{{webhookId}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          },
          {
            "name": "webhookId",
            "type": "String",
            "description": "The ID of the webhook to delete.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "files",
    "meta": {
      "short": "Files",
      "description": "Retrieve uploaded files for a specific form."
    },
    "endpoint": "/form/{{form_id}}/files",
    "fields": [
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Name of the file."
        }
      },
      {
        "name": "url",
        "type": "String",
        "selector": [
          "url"
        ],
        "meta": {
          "description": "URL to download or view the file."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "reports",
    "meta": {
      "short": "Reports",
      "description": "Generate and retrieve reports based on form submissions."
    },
    "endpoint": "/report/{{id}}",
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the report."
        }
      },
      {
        "name": "form_id",
        "type": "String",
        "selector": [
          "form_id"
        ],
        "meta": {
          "description": "ID of the form the report generated from."
        }
      },
      {
        "name": "title",
        "type": "String",
        "selector": [
          "title"
        ],
        "meta": {
          "description": "Title of the report."
        }
      },
      {
        "name": "created_at",
        "type": "String",
        "selector": [
          "created_at"
        ],
        "meta": {
          "description": "Date and time when the report was created."
        }
      },
      {
        "name": "status",
        "type": "String",
        "selector": [
          "status"
        ],
        "meta": {
          "description": "Status of the report."
        }
      },
      {
        "name": "url",
        "type": "String",
        "selector": [
          "url"
        ],
        "meta": {
          "description": "URL of the report."
        }
      },
      {
        "name": "is_protected",
        "type": "Boolean",
        "selector": [
          "isProtected"
        ],
        "meta": {
          "description": "Indicates if the report is password protected."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "/user/reports",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "list_by_form": {
        "method": "GET",
        "path": "/form/{{form_id}}/reports",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "form_id",
            "type": "String",
            "description": "The ID of the form.",
            "required": true
          }
        ]
      },
      "read": {
        "method": "GET",
        "path": "/report/{{id}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the report.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "folders",
    "meta": {
      "short": "Folders",
      "description": "Manage user folders."
    },
    "endpoint": "/folder/{{id}}",
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the folder."
        }
      },
      {
        "name": "owner",
        "type": "String",
        "selector": [
          "owner"
        ],
        "meta": {
          "description": "Username of the folder owner."
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Name of the folder."
        }
      },
      {
        "name": "color",
        "type": "String",
        "selector": [
          "color"
        ],
        "meta": {
          "description": "Color associated with the folder."
        }
      },
      {
        "name": "forms",
        "type": "Array",
        "selector": [
          "forms"
        ],
        "meta": {
          "description": "Array of forms in the folder."
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": "/user/folders",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      },
      "read": {
        "method": "GET",
        "path": "",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "id",
            "type": "String",
            "description": "The ID of the folder.",
            "required": true
          }
        ]
      }
    }
  },
  {
    "handle": "system",
    "meta": {
      "short": "System",
      "description": "Retrieve system plan and time information."
    },
    "endpoint": "/system",
    "fields": [
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Name of the plan."
        }
      },
      {
        "name": "price",
        "type": "String",
        "selector": [
          "price"
        ],
        "meta": {
          "description": "Price of the plan."
        }
      },
      {
        "name": "time",
        "type": "String",
        "selector": [
          "time"
        ],
        "meta": {
          "description": "System time."
        }
      }
    ],
    "operations": {
      "plan_read": {
        "method": "GET",
        "path": "/plan/{{planName}}",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": "",
        "placeholders": [
          {
            "name": "planName",
            "type": "String",
            "description": "The name of the plan (e.g., FREE, PREMIUM).",
            "required": true
          }
        ]
      },
      "time_read": {
        "method": "GET",
        "path": "/time",
        "headers": {},
        "queryParams": {},
        "bodyTemplate": ""
      }
    }
  }
]