Connections

Manage a custom connection object

Create or update a custom connection object

put/connection

Request

  • Base URL
    https://api.floweq.com/v1
  • Auth
    HTTP bearer

Request body

sourcestring

Record source

contextstring

Client ID

recordstring

Record ID

customVariablesobject

Object that contains custom variables for the client to consume. Keys must be strings (no spaces). Variables are then accessible by the client as custom.{Key}.`

languagestring

Optional: Sets the language for text sent by Sidekick to the end-user

Example request

{
  "context": "floweq",
  "record": "1029384756",
  "source": "freshchat",
  "customVariables": {
    "myVariableAccessor": "myVariableValue",
    "another_variable": "This is a different value"
  },
  "language": "de"
}

Response

Details of the invidual connection object

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.