Skip to content

feat(docs): clean table formatting #1626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oliwiapolec wants to merge 8 commits into
base: master
Choose a base branch
from
+3,176 −3,177
Open

feat(docs): clean table formatting #1626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
94e8d90
feat(docs): clean table formatting
oliwiapolec Dec 4, 2025
346d6d8
Merge branch 'master' into feature/update-table-formatting
oliwiapolec Dec 4, 2025
b80bccb
fix(docs): add missing articles in reports and config apis
oliwiapolec Dec 8, 2025
3825bb3
Merge branch 'master' into feature/update-table-formatting
oliwiapolec Dec 17, 2025
a330f2e
feat(docs): apply markdown formatting
oliwiapolec Dec 17, 2025
5ac5041
feat(docs): add missing articles
oliwiapolec Dec 18, 2025
19c103d
feat(docs): add missing punctuation
oliwiapolec Dec 18, 2025
7ead3b3
feat(docs): change capitalization
oliwiapolec Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
244 changes: 122 additions & 122 deletions src/pages/data-reporting/reports-api/index.mdx
View file
Open in desktop

Large diffs are not rendered by default.

244 changes: 122 additions & 122 deletions src/pages/data-reporting/reports-api/v3.7/index.mdx
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/pages/extending-chat-widget/customer-sdk/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ Parameters:
| parameters | type | description |
| ---------- | ------ | --------------------------------------------------- |
| id | string | ID of the chat whose properties you want to delete. |
| properties | object | Chat properties to delete |
| properties | object | The chat properties to delete. |

Returned value:

Expand Down Expand Up @@ -1154,7 +1154,7 @@ Parameters:
| parameters | type | description |
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------- |
| active | boolean | Optional, defaults to `true` but can be used to create threads that are immediately inactive |
| continuous | boolean | Optional, starts chat as continuous (online group is not required); default: false. |
| continuous | boolean | Optional, starts the chat as continuous (online group is not required); default: false. |
| chat.access | access | Optional; chat access to set, default: all agents. |
| chat.properties | object | Optional, [default properties docs](https://platform.text.com/docs/messaging/references/default-properties) |
| chat.thread.events | event[] | Optional; initial events that will immediately become a part of the created thread. |
Expand Down
2 changes: 1 addition & 1 deletion src/pages/extending-chat-widget/customer-sdk/v2.0/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ Parameters:
| parameters | type | description |
| ---------- | ------ | --------------------------------------------------- |
| chatId | string | ID of the chat whose properties you want to delete. |
| properties | object | Chat properties to delete |
| properties | object | The chat properties to delete. |

Returned value:

Expand Down
2 changes: 1 addition & 1 deletion src/pages/extending-chat-widget/customer-sdk/v3.0/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ Parameters:
| parameters | type | description |
| ---------- | ------ | --------------------------------------------------- |
| id | string | ID of the chat whose properties you want to delete. |
| properties | object | Chat properties to delete |
| properties | object | The chat properties to delete. |

Returned value:

Expand Down
884 changes: 442 additions & 442 deletions src/pages/management/configuration-api/index.mdx
View file
Open in desktop

Large diffs are not rendered by default.

999 changes: 499 additions & 500 deletions src/pages/management/configuration-api/v3.7/index.mdx
View file
Open in desktop

Large diffs are not rendered by default.

56 changes: 28 additions & 28 deletions src/pages/management/webhooks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ Indicates about a chat coming with a new thread. The webhook payload contains th

#### Webhook payload

| Field | Notes |
| ------ | ----------------------------------------------------------------------- |
| `chat` | [Chat data structure](/messaging/agent-chat-api/data-structures/#chats) |
| Field | Notes |
| ------ | ---------------------------------------------------------------------------- |
| `chat` | The [chat data structure](/messaging/agent-chat-api/data-structures/#chats). |

</Text>

Expand Down Expand Up @@ -173,10 +173,10 @@ Indicates about the update of a user's access to a particular chat. It contains

#### Webhook payload

| Field | Notes |
| -------- | -------------------------------------------------------------------------------------------------- |
| `id` | Chat ID |
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.6/data-structures/#access-1) data structure |
| Field | Notes |
| -------- | --------------------------------------------------------------------------------------------------- |
| `id` | The chat ID. |
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.6/data-structures/#access-1) data structure. |

</Text>

Expand Down Expand Up @@ -230,12 +230,12 @@ Indicates that a chat was transferred to a different group or to an agent.

#### Webhook payload

| Field | Notes |
| ---------------- | ------------------------------------------------------------------------ |
| `thread_id` | Present if the chat is active. |
| `transferred_to` | IDs of the groups and agents the chat is assigned to after the transfer. |
| `reason` **\*** | Indicates why the chat was transferred. |
| `queue` | Present if the chat is queued after the transfer. |
| Field | Notes |
| ---------------- | ---------------------------------------------------------------------------- |
| `thread_id` | Present if the chat is active. |
| `transferred_to` | The IDs of the groups and agents the chat is assigned to after the transfer. |
| `reason` **\*** | Indicates why the chat was transferred. |
| `queue` | Present if the chat is queued after the transfer. |

**\*)**
Possible reasons: `manual`, `inactive`, `assigned`, `unassigned`, `other`.
Expand Down Expand Up @@ -295,9 +295,9 @@ Indicates that a user (customer or agent) was added to a chat.

#### Webhook payload

| Field | Notes |
| ----------- | ------------------------------------ |
| `user_type` | Possible values: `agent`, `customer` |
| Field | Notes |
| ----------- | ------------------------------------- |
| `user_type` | Possible values: `agent`, `customer`. |

</Text>

Expand Down Expand Up @@ -354,9 +354,9 @@ Indicates that a user (customer or agent) was removed from a chat.

#### Webhook payload

| Field | Notes |
| ----------- | ------------------------------------ |
| `user_type` | Possible values: `agent`, `customer` |
| Field | Notes |
| ----------- | ------------------------------------- |
| `user_type` | Possible values: `agent`, `customer`. |

</Text>

Expand Down Expand Up @@ -855,9 +855,9 @@ Indicates about those event properties that were updated.

#### Webhook payload

| Field | Notes |
| ------------ | --------------------------------------------------------------------------------------------------------------- |
| `properties` | This is not a full `properties` object. This webhook shows only the properties that have been recently updated. |
| Field | Notes |
| ------------ | ------------------------------------------------------------------------------------------------------- |
| `properties` | Not a full `properties` object. This webhook shows only the properties that have been recently updated. |

</Text>

Expand Down Expand Up @@ -915,9 +915,9 @@ Indicates about those event properties that were deleted.

#### Webhook payload

| Field | Notes |
| ------------ | --------------------------------------------------------------------------------------------------------------- |
| `properties` | This is not a full `properties` object. This webhook shows only the properties that have been recently updated. |
| Field | Notes |
| ------------ | ------------------------------------------------------------------------------------------------------- |
| `properties` | Not a full `properties` object. This webhook shows only the properties that have been recently updated. |

</Text>

Expand Down Expand Up @@ -1077,9 +1077,9 @@ Indicates that an agent's or bot's status has changed.

#### Webhook payload

| Field | Notes |
| -------- | ------------------------------------------------------------------------------------ |
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for Bots only) |
| Field | Notes |
| -------- | ------------------------------------------------------------------------------------- |
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for bots only). |

</Text>

Expand Down
44 changes: 22 additions & 22 deletions src/pages/management/webhooks/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ Indicates about a chat coming with a new thread. The webhook payload contains th

#### Webhook payload

| Field | Notes |
| ------ | ----------------------------------------------------------------------- |
| `chat` | [Chat data structure](/messaging/agent-chat-api/data-structures/#chats) |
| Field | Notes |
| ------ | ---------------------------------------------------------------------------- |
| `chat` | The [chat data structure](/messaging/agent-chat-api/data-structures/#chats). |

</Text>

Expand Down Expand Up @@ -173,10 +173,10 @@ Indicates about the update of a user's access to a particular chat. It contains

#### Webhook payload

| Field | Notes |
| -------- | -------------------------------------------------------------------------------------------------- |
| `id` | Chat ID |
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.7/data-structures/#access-1) data structure |
| Field | Notes |
| -------- | --------------------------------------------------------------------------------------------------- |
| `id` | The chat ID. |
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.7/data-structures/#access-1) data structure. |

</Text>

Expand Down Expand Up @@ -230,12 +230,12 @@ Indicates that a chat was transferred to a different group or to an agent.

#### Webhook payload

| Field | Notes |
| ---------------- | ------------------------------------------------------------------------ |
| `thread_id` | Present if the chat is active. |
| `transferred_to` | IDs of the groups and agents the chat is assigned to after the transfer. |
| `reason` **\*** | Indicates why the chat was transferred. |
| `queue` | Present if the chat is queued after the transfer. |
| Field | Notes |
| ---------------- | ---------------------------------------------------------------------------- |
| `thread_id` | Present if the chat is active. |
| `transferred_to` | The IDs of the groups and agents the chat is assigned to after the transfer. |
| `reason` **\*** | Indicates why the chat was transferred. |
| `queue` | Present if the chat is queued after the transfer. |

**\*)**
Possible reasons: `manual`, `inactive`, `assigned`, `unassigned`, `other`.
Expand Down Expand Up @@ -295,9 +295,9 @@ Indicates that a user (customer or agent) was added to a chat.

#### Webhook payload

| Field | Notes |
| ----------- | ------------------------------------ |
| `user_type` | Possible values: `agent`, `customer` |
| Field | Notes |
| ----------- | ------------------------------------- |
| `user_type` | Possible values: `agent`, `customer`. |

</Text>

Expand Down Expand Up @@ -354,9 +354,9 @@ Indicates that a user (customer or agent) was removed from a chat.

#### Webhook payload

| Field | Notes |
| ----------- | ------------------------------------ |
| `user_type` | Possible values: `agent`, `customer` |
| Field | Notes |
| ----------- | ------------------------------------- |
| `user_type` | Possible values: `agent`, `customer`. |

</Text>

Expand Down Expand Up @@ -1077,9 +1077,9 @@ Indicates that an agent's or bot's status has changed.

#### Webhook payload

| Field | Notes |
| -------- | ------------------------------------------------------------------------------------ |
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for Bots only) |
| Field | Notes |
| -------- | ------------------------------------------------------------------------------------- |
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for bots only). |

</Text>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/messaging/agent-chat-api/data-structures/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ It is not possible to send a System event in API version 3.6.
| `created_at` | optional | |
| `email` | optional | |
| `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.6/#request-email-verification). |
| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. |
| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. |
| `name` | optional | |
| `phone_number` | optional | |
| `events_seen_up_to` | optional | RFC 3339 datetime string |
Expand Down
Loading