NexusKit

Module

Onboarding

Flux d\'onboarding multietapes avec suivi de progression, webhooks de complétion et protection anti-bots intégrée.

Commencer gratuitementDocumentation API

Fonctionnalités

Tout ce dont vous avez besoin pour exécuter des flux d\'onboarding structurés via API.

Flux multietapes

Définissez des flux d'onboarding avec des étapes JSON arbitraires. Chaque étape collecte des données et fait progresser la session.

Suivi de progression

Suivez currentStep, le payload accumulé et le statut de complétion par session.

Webhooks de complétion

Déclenchez des événements onboarding.completed vers vos endpoints webhook lorsqu'une session se termine.

Captcha Turnstile

Protection anti-bots sur la première étape via Cloudflare Turnstile. Désactivable en développement.

Protection honeypot

Champ caché sur l'étape 0 qui supprime silencieusement les sessions de bots.

Export CSV

Exportez toutes les sessions avec le statut de complétion, les payloads et les horodatages.

Cas d'utilisation

Tout workflow qui collecte des données étape par étape peut utiliser NexusKit Onboarding.

Onboarding client

Guidez les nouveaux utilisateurs à travers la configuration du compte, les préférences et les premiers pas dans votre produit.

Qualification de leads

Formulaires multiétapes qui collectent progressivement plus de détails avant d'être transmis au service commercial.

Onboarding employés

Workflows structurés pour l'intégration de nouveaux employés, la collecte de documents et le suivi de la formation.

KYC et vérification

Flux de vérification d'identité étape par étape avec téléchargement de documents et phases de révision.

Comment fonctionne l'API

Créez un flux, démarrez une session et faites progresser étape par étape.

1. Créer un flux

POST /v1/onboarding/flows
{
  "name": "Configuration nouvel utilisateur",
  "steps": [
    { "type": "info", "label": { "fr": "Bienvenue" } },
    { "type": "form", "label": { "fr": "Vos informations" } },
    { "type": "confirm", "label": { "fr": "Vérification" } }
  ]
}

2. Démarrer une session

POST /v1/public/onboarding/flows/:flowId/sessions
{
  "locale": "fr",
  "turnstileToken": "..."
}

3. Avancer étape par étape

PATCH /v1/public/onboarding/sessions/:sessionId
{
  "payload": { "name": "Jean Dupont", "email": "[email protected]" }
}
// Réponse : { "currentStep": 1, "completedAt": null }

Lorsque currentStep atteint le nombre total d'étapes, la session est marquée comme terminée et un webhook est déclenché.

FAQ

Comment fonctionnent les flux multietapes ?

Définissez un flux avec un tableau d'étapes JSON. Chaque appel PATCH à l'API publique fait progresser la session d'une étape en fusionnant le payload de l'étape. Lorsque currentStep >= steps.length, la session est marquée comme terminée.

NexusKit Onboarding est-il gratuit ?

Oui, dans le cadre d'une utilisation équitable : 5 000 sessions d'onboarding par mois, 120 requêtes par minute.

Puis-je déclencher des actions à la complétion ?

Oui. Configurez des endpoints webhook dans le tableau de bord. L'événement onboarding.completed est déclenché avec le payload complet de la session lorsqu'un flux se termine.

Comment Turnstile fonctionne-t-il avec plusieurs étapes ?

Turnstile n'est vérifié qu'à l'étape 0 (création de la session). Les étapes suivantes ne nécessitent pas de captcha.

Puis-je collecter différentes données par étape ?

Oui. Chaque étape possède sa propre structure de payload. La session accumule tous les payloads d'étapes en un seul objet JSON.

Prêt à créer des flux d'onboarding ?

Commencez gratuitement. Sans carte bancaire. Configurez votre premier flux en quelques minutes.

Créer un compte gratuitDocumentation API