# Conversation Handover message

## What is a conversation handover message?

In OpenDialog webchat, using a conversation handover message means that new messages sent by the user are not sent to the `incoming/webchat` endpoint, but are handled by an external system.

Hand to system messages contain a number of `data` elements that have a unique name specifying what they are for. This way, any custom data payload can be sent with hand to system messages

## When to use a conversation handover message

Conversation handover messages are intended to be used to inform OpenDialog that the handling of chat has been taken over by another channel (typically a human).

## How to create a conversation handover message

### Via the no-code conversation handover message in Message Editor

<figure><img src="/files/vDV5CKG2LcOEmnqyG2GP" alt=""><figcaption><p>How to create a conversation handover message in the no code message editor</p></figcaption></figure>

Navigate to the [Message Editor](/opendialog-platform/conversation-designer/message-design/message-editor.md) and create a conversation handover block by clicking the *Add conversation handover block* icon in the Layout section.

From here you can fill out the text you want your message to initially read, link your message to a specific handover integration, and then set any text you want to display should your customer be passed back from the live agent to your OpenDialog chatbot.

{% hint style="success" %}

* Open your OpenDialog application
* Select the Scenario that you wish to edit
* Select Design from the left hand panel and select Messages
* Go into the message that you want to add a message block to
* Add a 'Conversation Handover' message block
* Add in your own text to the fields you want to customise
* To preview your message, go to the Preview section
  {% endhint %}

### Via the custom message in Message Editor

<figure><img src="/files/DO1WdqqRgTSNxpSYX4Co" alt=""><figcaption><p>How to create a conversation handover message in the XML snippet</p></figcaption></figure>

Navigate to the [Message Editor](/opendialog-platform/conversation-designer/message-design/message-editor.md) and create a conversation message\`*.* Select `hand-to-system-message` from the message type drop down menu and the XML Snippet field will automatically be populated with a code template.

Fill in the template with the [properties ](#properties)of your particular message and when you are happy with it make sure to save your message and test it in the Test Preview chat window.

{% hint style="success" %}

* Open your OpenDialog application
* Select the Scenario that you wish to edit
* Select Design from the left hand panel and select Messages
* Go into the message that you want to add a message block to
* Add a 'Custom Message' block
* Select 'Conversation Handover' from the drop down
* Add in your own text to the fields you want to customise
* To preview your message, go to the Preview section
  {% endhint %}

#### XML Snippet

```xml
 <hand-to-system-message system="chatwoot">
    <data name="handover_text">You are now connected to a live agent. They will be with you shortly.</data>
    <data name="handover_id">my_configured_handover_id</data>
    <data name="handover_return_text">Thanks for chatting with our agent. Is there anything else we can help you with today?</data>
 </hand-to-system-message>
```

## How to use a conversation handover message

{% embed url="<https://www.loom.com/share/606e24e270bb42cea53a68c2203059c7?sid=2d4ccbdb-35d4-44fe-9a61-3b1bd876b1d1>" %}

{% hint style="success" %}
**Saving a message:** Always remember to hit 'Save Message' before closing or navigating away from the edit screen.
{% endhint %}

## How to construct a conversation handover message

When structuring a message, you are able to use multiple different message blocks together to create the message that you are looking for. However, when it comes to ordering and structing these, there are some rules that need to be followed. To learn more about this, please head to the [Constructing Messages ](/opendialog-platform/conversation-designer/message-design/constructing-messages.md)page for more information.

{% hint style="info" %}
For all message types, a key element to take into consideration is **Accessibility**, especially for messages that include customisation with multimedia types such as buttons, images and links. For all information on accessibility within OpenDialog, please click [here](/opendialog-platform/conversation-designer/designing-accessible-chatbots.md).
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.opendialog.ai/opendialog-platform/conversation-designer/message-design/message-types/conversation-handover-message.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
