---
title: "Create Webchat Button"
method: POST
path: "/webchat/buttons"
tags: ["Web Chat"]
---

# Create Webchat Button

`POST /webchat/buttons`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/webchat/buttons`
- Auth: HTTP bearer

Add a quick-action button.

`value` is read according to `action`: a URL for `link`, the question text
for `question`, a calendar slug for `calendar`.

## Headers

- `Idempotency-Key` string, nullable: Retry-safety key for this create. Replaying the same key returns the FIRST result instead of creating a second row. Durability depends on the tenant's migration state, so treat it as best-effort.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ButtonCreateRequest: A quick-action button in the widget. `value` means something different per `action`: a URL for `link`, the question text for `question`, a calendar slug for `calendar`. Sending the wrong kind is accepted here and fails at the widget, so it is spelled out rather than left to be discovered.
  - `chat_bot_id` string, required: Owning chat bot id (UUID).
  - `label` string, required
  - `action` 'link' | 'question' | 'calendar', required
  - `value` string, required: URL for `link`, question text for `question`, slug for `calendar`.
  - `icon` string, nullable
  - `category` string, required
  - `paths` string[]: URL paths where the button appears.
  - `active` boolean
  - `surface` 'external' | 'internal', nullable: NULL shows it on BOTH widgets.

## Response `201`

Successful Response

- ApiResponseWebchatPayload
  - `data` WebchatPayload, required: An open envelope for one webchat object. Open because the widget's config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)