Jotform

Visão geral

JotForm é um criador de formulários online que permite criar e gerenciar formulários para coleta de dados, pesquisas e muito mais. Com a integração JotForm no SquadOS, seus agentes podem clonar formulários, organizar rótulos, consultar envios de usuários e atualizar configurações de conta diretamente nas automações.

Site oficial: https://www.jotform.com/
Documentação na Composio: docs.composio.dev/toolkits/jotform

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
`api_key`	Sim	Chave de API da sua conta JotForm, usada para autenticar todas as requisições.

Como obter a credencial

Acesse jotform.com/myaccount/api (faça login se necessário).
No lado direito da página, clique em Create New Key (Criar nova chave).
Selecione a chave recém-criada e informe um rótulo descritivo para identificá-la.
Na coluna Permissions, clique na seta do menu suspenso e escolha o nível de acesso: Full Access para operações de leitura e escrita ou Read Access para somente leitura.
Copie o valor da chave gerada — esse é o valor a usar no campo api_key ao conectar no SquadOS.

Como conectar no SquadOS

Acesse Ferramentas no menu lateral (/admin/tools).
Abra a aba Disponíveis e procure por Jotform.
Clique no card para abrir o modal de detalhes e em Conectar.
Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Clonar formulário

JOTFORM_CLONE_FORM

Clona um formulário existente no JotForm, criando uma cópia completa com todas as perguntas e configurações. Use quando precisar duplicar um formulário existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do formulário a clonar. É o identificador único do formulário que você deseja duplicar.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar rótulo

JOTFORM_CREATE_LABEL

Cria um novo rótulo para organizar formulários no JotForm. Use quando precisar categorizar ou agrupar formulários com um nome.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do rótulo a criar. Campo obrigatório.
`color`	string	Não	Código de cor do rótulo em formato hexadecimal (ex.: #F09E39, #FF5733). Se não informado, o sistema atribuirá uma cor padrão.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir rótulo

JOTFORM_DELETE_LABEL

Exclui um rótulo junto com todos os seus sub-rótulos. Use quando precisar remover um rótulo da conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do rótulo a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter rótulo

JOTFORM_GET_LABEL

Recupera os detalhes de um rótulo pelo seu ID, incluindo nome e cor. Use quando precisar buscar informações sobre um rótulo específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do rótulo para buscar os detalhes.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter recursos do rótulo

JOTFORM_GET_LABEL_RESOURCES

Retorna a lista de recursos (formulários) associados a um rótulo e suas informações. Use quando precisar recuperar os formulários organizados em um rótulo específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do rótulo para buscar os recursos.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter plano do sistema

JOTFORM_GET_SYSTEM_PLAN

Recupera os detalhes de um plano do sistema específico. Use quando precisar verificar limites e preços de um plano.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`planName`	string (`"FREE"` \| `"BRONZE"` \| `"SILVER"` \| `"GOLD"` \| `"PLATINUM"`)	Sim	Nome do plano do sistema a consultar.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter detalhes do usuário

JOTFORM_GET_USER_DETAILS

Recupera os detalhes do usuário autenticado, incluindo informações de conta e uso. Use após confirmar que a chave de API é válida.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter pastas do usuário

JOTFORM_GET_USER_FOLDERS

Recupera a lista de rótulos (substitutos de pastas) do usuário autenticado. Usa o endpoint GET /user/labels conforme a migração do JotForm de pastas para rótulos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`owner`	string	Não	Nome de usuário do proprietário ou ID de workspace/equipe. Condicionalmente obrigatório para algumas contas ou workspaces.
`add_resources`	boolean	Não	Inclui os recursos do rótulo (ex.: formulários) na resposta quando `true` (`addResources=1`).

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter formulários do usuário

JOTFORM_GET_USER_FORMS

Recupera a lista de formulários criados pelo usuário autenticado. Use após configurar a autenticação por chave de API.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`limit`	integer	Não	Número de formulários a retornar.
`folder`	string	Não	Filtrar por ID de pasta.
`offset`	integer	Não	Deslocamento para paginação.
`search`	string	Não	Consulta de busca.
`orderby`	string	Não	Campo pelo qual ordenar os resultados.
`sorting`	string	Não	Direção da ordenação: `ASC` ou `DESC`.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter histórico do usuário

JOTFORM_GET_USER_HISTORY

Busca registros do histórico de atividades do usuário. Use ao auditar ou filtrar ações do usuário por tipo ou data.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`date`	string (`"lastWeek"` \| `"lastMonth"` \| `"last3Months"` \| `"last6Months"` \| `"lastYear"` \| `"all"`)	Não	Intervalo de datas predefinido para limitar o histórico.
`action`	string	Não	Filtrar histórico por tipo de ação (ex.: `userCreation`, `formUpdate`, `apiKeyCreated`, `userLogout`).
`sortBy`	string (`"ASC"` \| `"DESC"`)	Não	Direção de ordenação dos resultados.
`endDate`	string	Não	Data de término (MM/DD/AAAA) para filtrar o histórico.
`startDate`	string	Não	Data de início (MM/DD/AAAA) para filtrar o histórico.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter relatórios do usuário

JOTFORM_GET_USER_REPORTS

Recupera a lista de URLs de relatórios para todos os formulários da conta. Inclui formatos Excel, CSV, gráficos imprimíveis e tabelas HTML incorporáveis.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações do usuário

JOTFORM_GET_USER_SETTINGS

Recupera as configurações do usuário autenticado. Use após confirmar que a chave de API é válida.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configuração do usuário por chave

JOTFORM_GET_USER_SETTINGS_BY_KEY

Recupera uma configuração específica do usuário pela chave. Use quando precisar de um único valor de configuração como e-mail, fuso horário, idioma ou site.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`settingsKey`	string	Sim	A chave de configuração específica do usuário a buscar. Chaves comuns incluem: `email`, `timezone`, `language`, `website`.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter envios do usuário

JOTFORM_GET_USER_SUBMISSIONS

Recupera todos os envios de todos os formulários da conta. O dicionário de respostas contém os dados dos envios com os IDs das perguntas como chaves. Use quando precisar acessar dados de envios em múltiplos formulários.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`limit`	integer	Não	Número de resultados em cada conjunto de resultados. Padrão: 20. Máximo: 1000.
`filter`	string	Não	Filtra os resultados para buscar um intervalo específico de envios. Informe como string JSON, ex.: `'{"new":"1"}'` para filtrar apenas novos envios.
`offset`	integer	Não	Início de cada conjunto de resultados para paginação. Padrão: 0.
`orderby`	string	Não	Ordenar resultados por um campo de envio: `id`, `form_id`, `IP`, `created_at`, `status`, `new`, `flag`, `updated_at`.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter uso do usuário

JOTFORM_GET_USER_USAGE

Recupera as estatísticas mensais de uso do usuário autenticado. Use para verificar envios de formulários, formulários de pagamento, envios SSL e armazenamento utilizado.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Remover recursos do rótulo

JOTFORM_REMOVE_LABEL_RESOURCES

Remove recursos (formulários) especificados de um rótulo pelos seus IDs e tipos. Use quando precisar desassociar formulários de um rótulo específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador único do rótulo do qual os recursos serão removidos.
`resources`	array	Sim	Lista de recursos (formulários) a remover do rótulo. Cada recurso deve especificar um `id` e um `type`.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar rótulo

JOTFORM_UPDATE_LABEL

Atualiza um rótulo existente com novos valores de nome ou cor. Use quando precisar modificar as propriedades de um rótulo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do rótulo a atualizar.
`name`	string	Não	Novo nome para o rótulo.
`color`	string	Não	Nova cor para o rótulo em formato hexadecimal (ex.: #FF5733).

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar configurações do usuário

JOTFORM_UPDATE_USER_SETTINGS

Atualiza as configurações do usuário, como fuso horário, idioma, e-mail e site. Use quando precisar modificar as configurações da conta do usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
`name`	string	Não	Nome completo do usuário.
`email`	string	Não	Novo endereço de e-mail do usuário.
`company`	string	Não	Nome da empresa do usuário.
`website`	string	Não	Nova URL do site do usuário.
`industry`	string	Não	Setor de atuação do usuário.
`language`	string	Não	Código de idioma preferido pelo usuário (ex.: `en`, `es`, `fr`).
`time_zone`	string	Não	Identificador de fuso horário IANA do usuário (ex.: `America/New_York`, `Europe/London`).
`securityAnswer`	string	Não	Resposta à pergunta de segurança.
`securityQuestion`	string	Não	Pergunta de segurança para recuperação de conta.

Saída

Nome	Tipo	Obrigatório	Descrição
`data`	string	Sim	Dados retornados pela execução da ação.
`error`	string	Não	Mensagem de erro caso a execução tenha falhado.
`successful`	boolean	Sim	Indica se a ação foi executada com sucesso.