Integrate APIs

Send or retrieve data for use in your conversations with API calls in your NLX workspace

What are API integrations?

API integrations allow you to set up various API calls that can send or receive data with front-end interfaces or backend systems during conversation. They can be used to fetch information that's stored as variables in a conversation workflow or to invoke certain functions (send SMS/email, lookup user profile, create ticket) at strategic points of a conversation session.

• Data requests: Sending or receiving data that can be stored as variables in a flow

• Actions: Sending information or triggering an action (send email, create ticket) in a flow

• Lifecycle hook: Sending or receiving data or triggering an action at particular stages in a conversation session (lifecycles)

---

Requirements

An API integration must always employ the following to function:

• static or external implementation setup

• Response and/or Request model schema defined

For Data requests or Actions

• invoked in intent flow via corresponding node

For Lifecycle Hook

• invoked when assigned to a bot lifecycle stage

---

API integrations

Data requestsActionsLifecycle hooks