Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nippy.la/llms.txt

Use this file to discover all available pages before exploring further.

​
Examples of what you can ask your agent

  • “Create a landing page for the May campaign, asking for name, email, and phone”
  • “I want registrants to be sent to the welcome roulette”
  • “How many people have completed registration in my flows?”
  • “What’s my overall conversion rate across all landing pages?”
  • “Set UTM source=whatsapp and campaign=may-launch on this campaign’s flow”
Flows lets you create registration pages for your campaigns directly from chat. You tell it what data to capture, where to redirect after registration (a roulette, a course, a link), and your agent puts it all together. What you create via MCP is a scaffold — you can finish configuring it in the Console afterwards.
The flow created via MCP is a scaffold. After creation, additional configuration is required from the Console (uploading documents, configuring Palenca, adding additional redirects, etc.).

​
Read tools

​
flows_list_flows

Lists the flows for this business.
​
limit
integer
default:"100"
Maximum number of flows to return.
Response includes: slug, name, isActive, completedCount, uniqueVisitCount, totalVisitCount, conversionRate, publicUrl 
{
  "name": "flows_list_flows",
  "arguments": {
    "limit": 20
  }
}

​
flows_get_flow_stats

Gets aggregated statistics for all flows in the business. No parameters. Response: totalFlows, activeFlows, inactiveFlows, totalCompletions, totalVisits, uniqueVisits, conversionRate 
{
  "name": "flows_get_flow_stats",
  "arguments": {}
}

​
flows_get_flow_by_slug

Gets detailed information for a specific flow by its slug.
​
slug
string
default:"''"
required
Slug of the flow to query.
Response: full document including registrationFields, redirect configuration, metrics, and publicUrl. 
{
  "name": "flows_get_flow_by_slug",
  "arguments": {
    "slug": "may-campaign-2026"
  }
}

​
Write tools — Creation

​
flows_propose_create_flow

Generates a preview of the flow scaffold. Does not write to the database. Validates that the slug is unique and the redirect target exists and belongs to the business.
​
name
string
required
Flow name.
​
slug
string
required
Unique slug in kebab-case (e.g. "may-campaign-2026"). Must be globally unique.
​
redirect_type
string
required
Redirect type upon registration completion. Must be one of: "roulette", "course", "survey", "event", "url".
​
redirect_target_id
string
default:"''"
Redirect target ID. Required if redirect_type is "roulette", "course", "survey", or "event".
​
redirect_url
string
default:"''"
Redirect URL. Required if redirect_type is "url".
​
registration_fields
array
List of registration fields. Each field is an object with:
  • text (string): visible field label
  • value (string): internal identifier
  • type (string): field type ("text", "email", "select", "phone", etc.)
  • placeholder (string): placeholder text
  • isRequired (boolean): whether it’s required
If omitted, default fields are used: First Name, Last Name, Country.
​
source
string
default:"''"
UTM source for campaign tracking.
​
medium
string
default:"''"
UTM medium for campaign tracking.
​
campaign
string
default:"''"
UTM campaign for campaign tracking.
​
content
string
default:"''"
UTM content for campaign tracking.
​
is_palenca_required
boolean
default:"false"
Whether the flow requires bank validation via Palenca.
{
  "name": "flows_propose_create_flow",
  "arguments": {
    "name": "May Campaign 2026",
    "slug": "may-campaign-2026",
    "redirect_type": "roulette",
    "redirect_target_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "registration_fields": [
      {
        "text": "Full name",
        "value": "fullName",
        "type": "text",
        "placeholder": "Your full name",
        "isRequired": true
      },
      {
        "text": "Email",
        "value": "email",
        "type": "email",
        "placeholder": "you@example.com",
        "isRequired": true
      },
      {
        "text": "WhatsApp",
        "value": "phone",
        "type": "phone",
        "placeholder": "+52 55 1234 5678",
        "isRequired": true
      },
      {
        "text": "Country",
        "value": "country",
        "type": "select",
        "placeholder": "Select country",
        "isRequired": true
      }
    ],
    "source": "whatsapp",
    "medium": "cpc",
    "campaign": "may-2026-launch",
    "content": "banner_01",
    "is_palenca_required": false
  }
}

​
flows_approve_create_flow

Creates the flow scaffold in the database. Same parameters as propose_create_flow.
Only call this tool after showing the user the propose_create_flow preview and receiving explicit confirmation.
Response: {"_id": "...", "slug": "may-campaign-2026", "publicUrl": "https://console.nippy.la/flow/may-campaign-2026", "status": "created", "message": "Flow scaffold created. Additional Console configuration may be needed."}

​
Write tools — Update

​
flows_propose_update_flow

Generates a preview of changes to apply to an existing flow. Does not write to the database. Only non-None fields are applied.
​
slug
string
required
Slug of the flow to update.
​
name
string
New flow name.
​
is_active
boolean
Activate or deactivate the flow.
​
redirect_type
string
New redirect type.
​
redirect_target_id
string
New redirect target ID.
​
redirect_url
string
New redirect URL.
​
registration_fields
array
New list of registration fields (replaces existing ones).
​
source
string
New UTM source.
​
medium
string
New UTM medium.
​
campaign
string
New UTM campaign.
​
content
string
New UTM content.
​
is_palenca_required
boolean
Whether Palenca validation is required.
{
  "name": "flows_propose_update_flow",
  "arguments": {
    "slug": "may-campaign-2026",
    "is_active": true,
    "campaign": "may-2026-launch-v2"
  }
}

​
flows_approve_update_flow

Applies changes to the flow. Same parameters as propose_update_flow.
Only call this tool after showing the user the propose_update_flow preview and receiving explicit confirmation.
Response: {"slug": "may-campaign-2026", "updated": true}
Schema references for the agent:
URINameDescription
nippy://flows/schema/schemasflows_schemasFlow fields
nippy://flows/schema/glossaryflows_glossaryBusiness terms and mappings
nippy://flows/skillflows_skillAgent instructions

​
Post-creation checklist

After creating a flow via MCP, complete these steps from the Console:
  1. Upload required documents (ID, license, etc.)
  2. Configure Palenca if bank validation is needed
  3. Add additional redirects (survey, event, url) if applicable
  4. Adjust authType if not WhatsApp (Google, both)
  5. End-to-end test the flow before sharing the public link