Criar formulário no Typeform, por uma API
Cria um formulário em um workspace e o retorna com id, ids dos campos e o link público em _links.display. Imagens em campos e telas já precisam existir na conta.
- Identificador
- typeform_create_form
A chamada
POST https://connect.reportei.com/api/tools/typeform_create_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"title": "<title>",
"workspace": {}
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| title | string | Sim | Title of the form. |
| workspace | object | Sim | Workspace that holds the form: the self.href of a workspace from List workspaces, like https://api.typeform.com/workspaces/Aw33bz. |
| type | string | Não | Form type. Typeform uses quiz when it is left out.Valores: quiz, classification, score, branching, classification_branching, score_branching |
| theme | object | Não | Theme of the form: https://api.typeform.com/themes/ followed by an id from List themes. Leaving it out applies a new copy of the default theme. |
| settings | object | Não | Form settings. Other keys of the Typeform settings object, like duplicate_prevention, also go here. |
| hidden | array | Não | Names of the hidden fields, filled from the form URL, like utm_source or email. |
| variables | object | Não | Starting values of the score and price variables, for quizzes and order forms. |
| welcome_screens | array | Não | Screens shown before the first question. |
| thankyou_screens | array | Não | Screens shown after the submission. |
| fields | array | Não | Questions of the form, in order. Each type takes its own options and validations. |
| logic | array | Não | Logic jumps and score or price calculations, one entry per field or hidden field that triggers them. |
Conexões possíveis
O seu cliente conecta a conta do Typeform uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/typeform, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/typeform_create_form. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Typeform
- Listar workspacesGETLista os workspaces que a conta alcança, entre suas organizações, com id, name, self.href e o número de formulários. Pagine com page até chegar ao page_count da resposta.
- Criar workspacePOSTCria um workspace na organização em que o usuário conectado é proprietário e o retorna com id e self.href.
- Listar formuláriosGETLista os formulários da conta, públicos e privados, com id, título, datas e o link público em _links.display. Pagine com page até chegar ao page_count da resposta.
- Consultar formulárioGETRetorna a definição inteira de um formulário: configurações, tema, workspace, hidden fields, telas, lógica e os campos com seus ids e refs. Os ids dos campos são o que as tools de respostas filtram.
- Atualizar formulárioPUTSubstitui a definição inteira de um formulário. Leia-o com Get form, altere o que precisar e envie tudo de volta: cada campo mantém seu id, e um campo deixado de fora é apagado junto com suas respostas nas respostas existentes.
- Listar respostasGETLista as respostas de um formulário, da mais nova para a mais antiga, com answers, hidden fields, variáveis, metadados e os horários landed_at e submitted_at. Respostas dos últimos 30 minutos podem não aparecer. O corpo traz total_items; para a próxima página, envie o response_id do último item como before.
- Buscar respostasPOSTBusca as respostas de um formulário por valores de resposta, tags, hidden fields, metadados ou horário de envio, todas as condições juntas. Use em vez de List responses para filtrar por uma resposta. Para a próxima página, envie o response_id do último item como before_response_id.
- Listar temasGETLista os temas da conta, do mais novo para o mais antigo, com id, nome, cores e fonte. Pagine com page até chegar ao page_count da resposta.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
