API Reference

This API documentation supports the public-facing API for the Chat Flow solution. Production API endpoints will be supplied.

External Link Callback

Direct end-user to external web page

The External Link Handler API directs end-users to an external site, gathers data, and returns them to the workflow built out in Chat Flow.

Direct an end-user to an external web page

post
/callback

The External Link Handler API allows you to direct an end-user to an external web page from within a Flow conversation and then return to the Flow conversation with optional additional data gathered from the external web page.The end-user can then continue with the conversational workflow according to the steps defined in Flow.

Header parameters
referencestringRequired

A reference to be passed as a header. This value is also required in the body section, please refer accordingly for the description.

Body
resultstringRequired

Used to evaluate success or failure in Flow and can be any value you wish to return for evaluation

Example: success
referencestringOptional

A unique hash generated by Flow based on SessionID and SourceID that allows us to identify the user's session. This value is automatically appended as a query parameter on external links and should be intercepted and returned with the callback for validation (in header and body): e.g. https://www.example.com?reference=f7_4hn5=8f&%#nK=

Responses
200

Successfully validated the response and returned data appended to matched session.

post
/callback
POST /callback HTTP/1.1
Host: flow-callback.clickatell.com/
reference: text
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "result": "success",
  "reference": "text",
  "data": {
    "invoice": 123456,
    "amount": 100
  }
}
No content

Wait for Callback

Wait for an external system to initiate a callback

The Wait for Callback node facilitates an asynchronous process external to Chat Flow and continues the flow when a callback is received. This node blocks the flow until a callback is received or the session times out. Timeout is 1 minute less than the session length.

This node must be used with the Set Variable node to set a UUID as a variable. The UUID is used in the Reference Field on the node and in the Callback API so that the Callback Handler can identify that the callback belongs to a specific session. Once the callback is received, the end-user can continue with the workflow built out in Chat Flow.

Wait for an external system to initiate a callback

post
/chat/callback

The Wait for Callback node was created to facilitate an asynchronous process external to Chat Flow. For example waiting for an external client system to generate an invoice.This node will block the flow until a callback was received or the timed out was reached. The timeout is 1 minute less that the session length. This node should be used in conjunction with the Set Variable Node to first set a UUID as a variable and then use that UUID in the Reference Field on the node and in the Callback API so that the Callback Handler can identify that the callback belong to a specific session.Once the callback is received the end-user can then continue with the conversational workflow according to the steps defined in Flow.

Header parameters
referencestringRequired

A reference to be passed as a header.

Body
objectOptionalExample: {"body":{"read":100},"result":{"ben":10}}
Responses
202

Successfully validated the response and returned data appended to matched session.

No content
post
/chat/callback
POST /chat/callback HTTP/1.1
Host: flow-callback.clickatell.com/
reference: text
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "body": {
    "read": 100
  },
  "result": {
    "ben": 10
  }
}
No content

PreviousChat Flow - External Link Handler APINextGeneral Information

Last updated