Créer un formulaire avec l'API Typeform

Crée un formulaire dans un workspace et le renvoie avec id, ids des champs et le lien public dans _links.display. Les images des champs et des écrans doivent déjà exister dans le compte.

Identifiant
typeform_create_form

L'appel

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": {}
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
titlestringOuiTitle of the form.
workspaceobjectOuiWorkspace that holds the form: the self.href of a workspace from List workspaces, like https://api.typeform.com/workspaces/Aw33bz.
typestringNonForm type. Typeform uses quiz when it is left out.Valeurs : quiz, classification, score, branching, classification_branching, score_branching
themeobjectNonTheme 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.
settingsobjectNonForm settings. Other keys of the Typeform settings object, like duplicate_prevention, also go here.
hiddenarrayNonNames of the hidden fields, filled from the form URL, like utm_source or email.
variablesobjectNonStarting values of the score and price variables, for quizzes and order forms.
welcome_screensarrayNonScreens shown before the first question.
thankyou_screensarrayNonScreens shown after the submission.
fieldsarrayNonQuestions of the form, in order. Each type takes its own options and validations.
logicarrayNonLogic jumps and score or price calculations, one entry per field or hidden field that triggers them.

Connexions possibles

Votre client connecte son compte Typeform une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/typeform, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/typeform_create_form. Il devient la définition de tool de votre agent sans conversion.

Autres tools Typeform

Voir les 9 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.