Mavenoid help center

Mavenoid help center

  • Admin
  • Flows
  • Agent dashboard

›How-to guides

Get started

  • Intro to flows
  • Tutorial - Create a flow for live support
  • Tutorial - Create a flow for troubleshooting
  • Tutorial - Create a flow for FAQs

Learn more

  • Understand the types of nodes
  • Working with symptoms and solutions
  • Working with backtracks and choice lists
  • Understand potential solutions
  • Understand escalation
  • Understand search
  • Understand step-by-step guides
  • Understand canvas notes
  • Understand form data
  • Understand markup
  • Understand secrets
  • Understand flow components
  • Understand conditions
  • Understand translations
  • Understand flow feedback
  • Best practices for writing flows

How-to guides

  • Preview nodes and flows
  • Embed images and files
  • Embed videos
  • Receive conversation transcript emails
  • Set a flow image
  • Work with step-by-step guides
  • Add canvas notes
  • Copy and paste nodes
  • Create and embed flow components
  • Work with conditions
  • Configure flow feedback
  • View and manage flow feedback
  • Export, import, and copy flows
  • Set flow visibility
  • Manage translations
  • Create a live support node
  • Create an external API node
  • Start the user on different nodes based on the embedding page
  • Dynamically populate a choice list form field

Reference

  • Text formatting
  • Live support settings
  • Actions settings
  • External API settings
  • Form field types
  • Reserved form data
  • Markup expressions and operators
  • Supported languages
  • Glossary of terms

Create an external API node

External API nodes still work, but for new flows we recommend using the Actions node instead for greater configurability.

Create the node

  1. Double-click the canvas background to create a new node.
  2. Select the node type Advanced → External → External API.

New node menu

  1. The node is added to the canvas.

Configure the node

The external API node is created with default settings. You can change these settings by editing the node.

Click the live support node to edit it.

Edit panel

For a detailed explanation of the settings and how they work, see External API settings.

Connect the node

Connect the live support node to the rest of your flow as desired.

External API node connected to rest of flow

  1. The connector on the left edge is the input connector and determines when the flow will enter this node and perform the external API request.
  2. The connector on the right edge is the output connector and determines where the flow will go next after the API call returns.

Handling errors

Because external API nodes introduce an external dependency to your flow, you should ensure your flow can handle errors or failures of the external API call. Any of the following events will cause the node to enter an error state:

  1. The HTTP request does not receive a response before the specified timeout duration passes.
  2. The HTTP response has a status code that does not match any of the allowed statuses.
  3. The response type is set to "JSON" and the HTTP response body is not valid JSON.

If an error occurs, the flow will still proceed by following the external API node's output connector, but none of the node's form data assignments will happen. This means that the easiest way to account for API errors is usually by using the "Fallback" option on later read data nodes.

Last updated on 2/18/2022
← Create a live support nodeStart the user on different nodes based on the embedding page →
  • Create the node
  • Configure the node
  • Connect the node
    • Handling errors
Help center
AdminFlowsAgent dashboard
Product
Self-serviceLive supportWhy Mavenoid?PricingGet a demoTry it free
Learn
Customer storiesBlogWebinarsHelp centerROI calculator
Company
About usCareersPressContact us
© Mavenoid AB 2023 • Privacy policy