This guide contains references for the endpoints used for Handover Protocol.
Allows an app to participate in Handover Protocol.
Endpoint | Description |
---|---|
| Allows an app to extend control of a conversation |
| Allows an app to pass control of a conversation to another app |
| Allows an app to pass information about a conversation to other apps linked to the Page during Handover Protocol |
| Allows an app to release control of a conversation before control expires |
Property | Description |
---|---|
| Required. A JSON object that contains the ID of the person receiving the message |
id int | The Page-scoped ID for the person receiving the message |
| The ID for the app that requested control of the conversation. Required when passing control of a conversation from one app to another To pass control to an inbox set the value to |
| Additional information about a conversation to be included in Handover Protocol webhook notifications. |
Endpoint | Description |
---|---|
| Allows a Primary Receiver app, if one is set, to retrieve the list of app |
| Allows a Primary Receiver app, if one is set, to retrieve the app ID for the app that current owns a conversation |