Yola Docs
  • Getting Started
    • Glossary
    • Signing-in
    • Main Dashboard
    • Platform Bot
    • Data Privacy
  • AICX Modules
    • AI Assistants
      • Manage Assistants
      • Actions
        • Send Message
        • Send File
        • Show Carousel
        • Show Survey
        • Collect Feedback
        • Create Ticket
        • Human Handoff
        • External Handoff
        • Jump to Trigger/Action
        • If/Else
        • Set Chat Variable
        • Send API Request
      • LLMs
        • Cloudflare Training
      • Publishing
        • Webchat
          • Proactive Messages
        • Facebook Messenger
        • WhatsApp
        • Telegram
        • LINE
        • Africa's Talking
        • Bitrix24
        • Zendesk
    • Inbox
      • Find & View Conversations
      • Message Editor
      • Transfers & Takeovers
    • Livechats
    • Tickets
    • People
    • Analytics
      • Winnow
  • General
    • Settings
      • Company
        • Plan & Billing
          • Interactions Amount
        • Roles & Permissions
        • Users
        • Teams
        • IP Allowlist
        • Whitelabelling
      • Sub-Company
        • Banning
        • Tags
        • Chat Assignment
        • Email Domains
        • Email Templates
        • Exports
        • Canned Replies
        • Custom Fields
        • Custom Profiles
        • Custom Analytics
      • User Account
        • User Aliases
        • Online Status
    • Plans & Pricing
    • Elite Suite Max
  • Developers
    • Developer Tools
      • Chat Variables
      • Chat Scripts
      • Webchat Script
      • Developer API
      • On-Premise & Hybrid Hosting
Powered by GitBook
On this page

Was this helpful?

  1. AICX Modules
  2. AI Assistants
  3. Actions

Send API Request

Leverage third-party utilities in a chat.

PreviousSet Chat VariableNextLLMs

Was this helpful?

The Send API Request action supercharges your AI assistant, allowing it to send custom requests to external systems and receive responses. This is useful for utilities like automations, external actions, database updates, and external reporting.


Select a Send API Request action from the tree to open its settings:

  • HTTP method — the request type:

    • GET — retrieves information about the REST API resource.

    • POST — creates a REST API resource.

    • PUT — updates a REST API resource.

    • DELETE — deletes a REST API resource or related component.

    • PATCH — makes a partial update to a REST API resource.

  • URL endpoint — the endpoint to receive requests, which must start with https://.

  • Headers — optional Key / Value pairs of content for the request header.

  • Resulting variable — the name of the new or existing whose value will be set in the chat by a GET response.

Press Save to confirm edits.

To test an API request, use a preview to interact with the AI assistant and trigger the request.

chat variable
Webchat