NudgeDocs
API et MCP

Endpoints publics des formulaires

Lisez la définition publique d'un formulaire et ses hôtes, et voyez comment faire entrer des leads dans Nudge par programme.

À quoi servent ces endpoints

Chaque formulaire Nudge a une adresse publique, https://app.asknudge.ai/{orgSlug}/{formSlug}. Les endpoints ci-dessous renvoient ce que cette page publique affiche déjà : les questions du formulaire, ses réglages publics et les personnes qu'un visiteur peut rencontrer. Ils ne demandent aucun identifiant.

Utilisez-les pour construire votre propre interface sur un formulaire, vérifier qu'un formulaire est en ligne, ou donner à un agent les questions à poser avant de réserver.

Les autres chemins sous /api/public/ sont utilisés en interne par l'agent site web et les pages de réservation (sessions de chat, balises de visite, réponses partielles, reçus de consentement…). Ils ne font pas partie de l'API publique et peuvent changer sans préavis. Ne les appelez pas.

Lire un formulaire

GET https://app.asknudge.ai/api/public/{orgSlug}/{formSlug}

Champ

Type

curl https://app.asknudge.ai/api/public/acme/demo-request

La réponse enveloppe le formulaire dans un objet form :

{
  "form": {
    "id": "frm_8k2m9q4t7v1x3z6c",
    "name": "Book a demo",
    "description": "30 minutes with our team",
    "slug": "demo-request",
    "form_type": "conversational",
    "fields": [],
    "screens": [],
    "settings": { "callDurationMinutes": 30, "timeFormat": "24h" },
    "redirect_url": null,
    "disqualification_message": null,
    "disqualification_redirect_url": null,
    "organization": { "slug": "acme", "name": "Acme" }
  }
}

Champ

Type

Le contenu exact de fields, screens et settings reflète ce que vous avez construit dans l'éditeur de formulaire : lisez-le comme des données, pas comme un schéma figé.

StatutSignification
200Le formulaire est actif et public.
404{"error":"Form not found"} : slugs inconnus, formulaire inactif ou espace suspendu.

Cet endpoint répond avec Access-Control-Allow-Origin: * : un navigateur peut l'appeler depuis n'importe quel site.

Lister les hôtes d'un formulaire

GET https://app.asknudge.ai/api/public/{orgSlug}/{formSlug}/hosts

Renvoie les membres de l'équipe avec qui un visiteur peut prendre rendez-vous sur ce formulaire. Aucune adresse e-mail n'est jamais renvoyée.

curl https://app.asknudge.ai/api/public/acme/demo-request/hosts
{
  "closers": [
    { "id": "tm_2v5b8n1m4k7j3h6g", "name": "Julia Martin", "initials": "JM", "avatar_url": "https://…" }
  ]
}

Champ

Type

404 si le formulaire n'existe pas. Cet endpoint n'envoie pas d'en-têtes CORS : appelez-le depuis votre serveur, pas depuis un navigateur sur un autre domaine.

Faire entrer des leads dans Nudge par programme

Les leads arrivent normalement dans Nudge par votre agent site web, vos pages de réservation et vos formulaires intégrés. Nudge y gère le consentement, la qualification, le scoring et l'attribution.

Pour créer un lead depuis votre code ou depuis un agent IA, utilisez l'API de réservation IA : son action book crée le contact (avec les réponses passées dans form_responses) et réserve le rendez-vous en un seul appel. Voir Réserver un rendez-vous.

Pour envoyer les leads hors de Nudge dès leur arrivée, abonnez une URL à l'événement lead_created : voir Webhooks.

Pour créer ou modifier des contacts depuis un assistant IA, utilisez les outils MCP contacts__create_contact et contacts__update_contact (voir la référence des outils MCP).

Sur cette page