API Reference
API Reference

Create Card Click Event

Log an EventLog for a client-side card click interaction.

POST/api/v1/agents/test/{test_id}/card-click

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

test_id string path required

Request body

application/json

body CardClickRequest required
2 fields
action_idstringrequired

Human-readable identifier for the card action.

Minimum length 1Maximum length 64Pattern ^[a-z0-9][a-z0-9_-]*$
action_typeenum<string>required

The type of action triggers, either "action", or "cta".

Allowed values ["action","cta"]
Request example
{
  "action_id": "string",
  "action_type": "action"
}

Responses

200Successful Response

application/json

response CardClickResponse required
1 field
statusstringrequired

The outcome of the request

Response example
{
  "status": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}