Custom API integrations

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

What are custom 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 that you own during a conversation with a user. They can be used to fetch information that's then 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 event (send email, create ticket) in a flow

• Lifecycle hook: Sending or receiving data or triggering an event at particular stages (lifecycles) in a conversation session (receive and set context or create a ticket at the 'start' lifecycle).

---

Requirements

A custom 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 a flow via corresponding node

For Lifecycle Hook

• invoked when assigned to an application's lifecycle stage

---

API integrations

Data requests

Actions

Lifecycle hooks