Start a conversation - Cadenya

cadenya-widgets conversations create \
  --message sample

{
  "id": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "state": "STATE_UNSPECIFIED",
  "createdAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "lastActiveAt": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

POST

/

v1

/

conversations

cadenya-widgets conversations create \
  --message sample

{
  "id": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "state": "STATE_UNSPECIFIED",
  "createdAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "lastActiveAt": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create conversation request. The session, tenant, subject, secrets, labels, and pinned parameters all come from the presenting token's session — the browser asserts nothing.

message

string

required

The visitor's opening message.

Response

OK

WidgetConversation is one conversation between a visitor and a widget's agent. The presenting session must have a tenant and subject. Sessions for that same identity share history on the same widget and agent, subject to the current session's permissions. Other conversation IDs return not found.

id

string

required

read-only

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

state

enum<string>

required

read-only

Available options:

STATE_UNSPECIFIED,

STATE_RESPONDING,

STATE_OPEN,

STATE_CLOSED

createdAt

string<date-time>

required

read-only

title

string

read-only

Server-derived display title (e.g. from the opening message).

lastActiveAt

string<date-time>

read-only

When the conversation last saw a message or event.