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âmetroTipoObrigatórioDescrição
titlestringSimTitle of the form.
workspaceobjectSimWorkspace that holds the form: the self.href of a workspace from List workspaces, like https://api.typeform.com/workspaces/Aw33bz.
typestringNãoForm type. Typeform uses quiz when it is left out.Valores: quiz, classification, score, branching, classification_branching, score_branching
themeobjectNãoTheme 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.
settingsobjectNãoForm settings. Other keys of the Typeform settings object, like duplicate_prevention, also go here.
hiddenarrayNãoNames of the hidden fields, filled from the form URL, like utm_source or email.
variablesobjectNãoStarting values of the score and price variables, for quizzes and order forms.
welcome_screensarrayNãoScreens shown before the first question.
thankyou_screensarrayNãoScreens shown after the submission.
fieldsarrayNãoQuestions of the form, in order. Each type takes its own options and validations.
logicarrayNãoLogic 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

Ver as 9 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.