---
title: "Click Events"
method: POST
path: "/v1/events"
tags: ["embed v1"]
---

# Click Events

`POST /v1/events`

## Request

- Base URL: `https://api.branchly.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.branchly.io/v1/events`
- Auth: none declared

## Headers

- `x-api-key` string, nullable

## Request body

- union
  - CustomClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'custom'
    - `data` CustomClickEventData, required
      - `url` string, uri, required: The URL where the event was triggered.
      - `metadata` object: Additional metadata for the event.
      - `event_name` string, required: The name of the custom event.
      - `element_text` string: The text of the clicked element.
  - SearchResultClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'search_result'
    - `data` SearchResultClickEventData, required
      - `url` string, uri, required: The URL of the clicked search result.
      - `index` integer, required: The position/index of the search result.
      - `title` string, required: The title of the search result.
      - `locale` string, required: The locale of the search result.
      - `vertex_id` string, uuid, required: The vertex ID of the search result.
  - ContactClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'contact'
    - `data` ContactClickEventData, required
      - `title` string, required: The title of the contact element.
      - `locale` string, required: The locale of the contact element.
      - `vertex_id` string, uuid, required: The vertex ID of the contact element.
  - LinkClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'link'
    - `data` LinkClickEventData, required
      - `url` string, uri, required: The URL of the clicked link.
      - `locale` string, required: The locale of the link.
  - FollowUpNavigationClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'follow_up_navigation'
    - `data` FollowUpNavigationClickEventData, required
      - `url` string, uri, required: The URL of the follow-up navigation.
      - `locale` string, required: The locale of the follow-up navigation.
  - FollowUpQuestionClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'follow_up_question'
    - `data` FollowUpQuestionClickEventData, required
      - `question` string, required: The follow-up question.
  - ToolClickEventRequest
    - `application_id` string, uuid, required
    - `session_id` string, uuid, required
    - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form', required
    - `event_type` 'tool'
    - `data` ToolClickEventData, required
      - `title` string, required: The title of the tool element.
      - `locale` string, required: The locale of the tool element.

## Response `202`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/branchly/apis/branchly-io-api.md) · [All operations](https://skmtc.dev/branchly/apis/branchly-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/branchly/apis/branchly-io-api/revisions/9ffb024f8ec8?raw)