Externallink

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clickatell/main/json-schema/clickatell-externallink-schema.json",
  "title": "Externallink",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clickatell-flow-openapi.json#/components/schemas/Externallink",
  "required": [
    "result"
  ],
  "type": "object",
  "properties": {
    "result": {
      "type": "string",
      "description": "Used to evaluate success or failure in Flow and can be any value you wish to return for evaluation"
    },
    "reference": {
      "type": "string",
      "description": "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=`"
    },
    "data": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "An optional hashmap with any key and value that can be referenced in the flow later on."
    }
  }
}