Pipeline Setup

Configure how OTP messages are delivered to your users through customizable pipelines.

Pipelines define the delivery channels, fallback order, and verification methods for OTP authentication. Each widget connects to a pipeline that controls the entire delivery flow.

Step 1: Basic Details

Navigate to OTP Pipelines in your dashboard and configure the basic pipeline settings.

Activation Required

You must activate your pipeline to start using it.

  • Name
    Pipeline ID
    Type
    string
    Description

    Auto-generated unique identifier for the pipeline (read-only)

  • Name
    Pipeline UID
    Type
    string
    Description

    UUID reference for API integrations (read-only)

  • Name
    Pipeline name
    Type
    string
    Description

    Internal name for your reference (e.g., "Production Auth Pipeline")

  • Name
    Pipeline Description
    Type
    string
    Description

    Optional description of this pipeline's purpose

  • Name
    Active
    Type
    select
    Description

    Set to "Active" to enable the pipeline or "Inactive" to disable

  • Name
    Type
    Type
    select
    Description

    Pipeline environment type: "Test" for development or "Production" for live traffic

Step 2: Callback URLs

Configure your front-end and back-end callback URLs for handling authentication results.

Required Configuration

You must setup your front-end callback URL to redirect the user after a successful or failed authentication.

Backend Webhook

You must setup your backend callback URL to receive the authentication response from Akedly servers to your webhook.

  • Name
    Front-end redirect URL
    Type
    string
    Description

    URL to redirect users after a successful or failed authentication (e.g., https://yourapp.com/auth/callback)

  • Name
    Back-end callback URL
    Type
    string
    Description

    Webhook endpoint to receive authentication responses from Akedly servers (e.g., https://yourapp.com/api/webhooks/akedly)

Click Update to save your callback URL configuration.

Step 3: Verification Methods

Configure the verification methods and their priority order for OTP delivery.

Priority Order Rules

Only WhatsApp or Telegram can be the #1 priority method. SMS is always sent last. Email is sent automatically if included in the API request.

Available Methods

  • Name
    WhatsApp
    Type
    priority
    Description

    Users receive their OTP through WhatsApp. Can be set as primary (#1) priority.

  • Name
    Telegram
    Type
    priority
    Description

    Users receive their OTP through Telegram's official OTP verification channel. Can be set as primary (#1) priority.

  • Name
    SMS
    Type
    fixed last
    Description

    Users receive their OTP through SMS. Always sent as the last fallback method.

Priority Configuration

  • Name
    Priority Order
    Type
    toggle
    Description

    Enable "Custom Order" to manually arrange method priorities

  • Name
    Add Method
    Type
    button
    Description

    Add additional verification methods to the pipeline

Use the drag handles to reorder methods or the arrow buttons to move them up/down in priority.

Next Steps

After creating your pipeline, link it to a widget in the Widget Setup page.

Was this page helpful?