Skip to content

feat: send_greeting_postback customer's method #1572

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

Merged
oliwiapolec merged 5 commits into from
Jul 8, 2025
Merged

feat: send_greeting_postback customer's method #1572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
28221df
feat: send_greeting_postback customer's method
mdojwa Jun 30, 2025
04b34cb
fix: changelog update
mdojwa Jul 4, 2025
0f334d7
Update src/pages/messaging/customer-chat-api/changelog/index.mdx
mdojwa Jul 8, 2025
0a17a5a
feat(docs): apply table formatting
oliwiapolec Jul 8, 2025
e05bc07
feat(docs): apply table formatting for rtm ref
oliwiapolec Jul 8, 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
3 changes: 3 additions & 0 deletions src/pages/messaging/customer-chat-api/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ The developer preview version provides a preview of the upcoming changes to the

- The **customer_page_updated** was removed.

### Other

- There's a new method, [**Send Greeting Postback**](/messaging/customer-chat-api/v3.6/#send-greeting-postback).

## [v3.5] - 2022-11-23

Expand Down
59 changes: 58 additions & 1 deletion src/pages/messaging/customer-chat-api/v3.6/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ curl -X POST \
| **Properties** | [`update_chat_properties`](#update-chat-properties) [`delete_chat_properties`](#delete-chat-properties) [`update_thread_properties`](#update-thread-properties) [`delete_thread_properties`](#delete-thread-properties) [`update_event_properties`](#update-event-properties) [`delete_event_properties`](#delete-event-properties) [`list_license_properties`](#list-license-properties) [`list_group_properties`](#list-group-properties) |
| **Customers** | [`update_customer`](#update-customer) [`set_customer_session_fields`](#set-customer-session-fields) [`get_customer`](#get-customer) |
| **Status** | [`list_group_statuses`](#list-group-statuses) |
| **Other** | [`check_goals`](#check-goals) [`get_form`](#get-form) [`get_predicted_agent`](#get-predicted-agent) [`get_url_info`](#get-url-info) [`mark_events_as_seen`](#mark-events-as-seen) [`accept_greeting`](#accept-greeting) [`cancel_greeting`](#cancel-greeting) [`request_email_verification`](#request-email-verification) |
| **Other** | [`check_goals`](#check-goals) [`get_form`](#get-form) [`get_predicted_agent`](#get-predicted-agent) [`get_url_info`](#get-url-info) [`mark_events_as_seen`](#mark-events-as-seen) [`accept_greeting`](#accept-greeting) [`cancel_greeting`](#cancel-greeting) [`request_email_verification`](#request-email-verification) [`send_greeting_postback`](#send-greeting-postback) |

## Chats

Expand Down Expand Up @@ -2184,6 +2184,63 @@ curl -X POST \

<Text>

### Send Greeting Postback

#### Specifics

| | |
| ---------------------- | --------------------------------------------------------------------------------------------------- |
| **Method URL** | `https://api.livechatinc.com/v3.6/customer/action/send_greeting_postback` |
| **RTM API equivalent** | [`send_greeting_postback`](/messaging/customer-chat-api/v3.6/rtm-reference/#send-greeting-postback) |
| **Webhook** | - |

#### Request

| Parameter | Required | Data type | Notes |
| ------------------------------- | -------- | --------- | --------------------------------------------------- |
| `greeting_unique_id` | Yes | `string` | |
| `postback` | Yes | `object` | |
| `postback.rich_message` | No | `object` | Required if `postback.url` is not provided |
| `postback.rich_message.id` | Yes | `string` | Postback name of the button |
| `postback.rich_message.toggled` | Yes | `bool` | Postback toggled; `true` or `false` |
| `postback.url` | No | `string` | Required if `postback.rich_message` is not provided |

#### Response

No response payload (`200 OK`).

</Text>

<Code>

<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
'https://api.livechatinc.com/v3.6/customer/action/send_greeting_postback?organization_id=<organization_id>' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <customer_access_token>' \
-d '{
"greeting_unique_id": "Q10X0W041P",
"postback": {
"rich_message": {
"id": "greeting_button_yes",
"toggled": true
}
}
}'
```

</CodeSample>

</Code>

</Section>

<Section>

<Text>

### Request Email Verification

Requests the verification of the customer's email address by sending them a verification email with the identity confirmation link.
Expand Down
70 changes: 69 additions & 1 deletion src/pages/messaging/customer-chat-api/v3.6/rtm-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ When connecting to the Customer Chat RTM API, clients have to send over the requ
| **Properties** | [`update_chat_properties`](#update-chat-properties) [`delete_chat_properties`](#delete-chat-properties) [`update_thread_properties`](#update-thread-properties) [`delete_thread_properties`](#delete-thread-properties) [`update_event_properties`](#update-event-properties) [`delete_event_properties`](#delete-event-properties) |
| **Customers** | [`update_customer`](#update-customer) [`update_customer_page`](#update-customer-page) [`set_customer_session_fields`](#set-customer-session-fields) [`get_customer`](#get-customer) |
| **Status** | [`login`](#login) [`list_group_statuses`](#list-group-statuses) |
| **Other** | [`get_form`](#get-form) [`get_predicted_agent`](#get-predicted-agent) [`get_url_info`](#get-url-info) [`mark_events_as_seen`](#mark-events-as-seen) [`accept_greeting`](#accept-greeting) [`cancel_greeting`](#cancel-greeting) |
| **Other** | [`get_form`](#get-form) [`get_predicted_agent`](#get-predicted-agent) [`get_url_info`](#get-url-info) [`mark_events_as_seen`](#mark-events-as-seen) [`accept_greeting`](#accept-greeting) [`cancel_greeting`](#cancel-greeting) [`send_greeting_postback`](#send-greeting-postback) |

</Text>

Expand Down Expand Up @@ -2198,6 +2198,74 @@ Cancels a greeting (an invitation to the chat). For example, Customers could can

<Text>

### Send Greeting Postback

#### Specifics

| | |
| ---------------------- | ------------------------------------------------------------------------------------- |
| **Action** | `send_greeting_postback` |
| **Web API equivalent** | [`send_greeting_postback`](/messaging/customer-chat-api/v3.6/#send-greeting-postback) |
| **Push message** | - |

#### Request

| Parameter | Required | Data type | Notes |
| ------------------------------- | -------- | --------- | --------------------------------------------------- |
| `greeting_unique_id` | Yes | `string` | |
| `postback` | Yes | `object` | |
| `postback.rich_message` | No | `object` | Required if `postback.url` is not provided |
| `postback.rich_message.id` | Yes | `string` | Postback name of the button |
| `postback.rich_message.toggled` | Yes | `bool` | Postback toggled; `true` or `false` |
| `postback.url` | No | `string` | Required if `postback.rich_message` is not provided |

</Text>

<Code>

<CodeSample path={'REQUEST'}>

```json
{
"action": "send_greeting_postback",
"payload": {
"greeting_unique_id": "Q10X0W041P",
"postback": {
"rich_message": {
"id": "greeting_button_yes",
"toggled": true
}
}
}
}
```

</CodeSample>

<CodeResponse>

```json
{
"request_id": "<request_id>", // optional
"action": "send_greeting_postback",
"type": "response",
"payload": {
// no response payload
},
"success": true
}
```

</CodeResponse>

</Code>

</Section>

<Section>

<Text>

# Pushes

Here's what you need to know about **pushes**:
Expand Down