External Link Callback

Direct an end-user to an external web page

post

https://flow-callback.clickatell.comhttps://control-callback-uat.payd.co

/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

application/json

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.

400

A bad/invalid reference was returned and the session could not be matched

post

/callback

HTTPcURLJavaScriptPython

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