Getting Started with the Messaging REST API

  1. Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing the following service name:

    • messagingRestApiDomain
  2. We do not provide a client SDK for calling this API. You can implement an HTTP Client in your preferred programming language, and start calling the API. Refer to the API Reference for details on required headers, supported authorization schemes, etc.

  3. Note the API terms of use.

  4. When using this API, it is recommended that you implement our Retry Policy and KeepAlive best practices.

Setting up Webhook Endpoints

This is an optional setup step, and only needed if you wish to use the Subscriptions API. Subscriptions allow you to receive notifications from Conversational Cloud whenever qualifying events occur on your brand's conversations.

The Webhook Endpoint setup is a two step process:

Stand up your Webhook Receiver Service

Develop and run an HTTP Service in your premises that is accessible over the public internet, and capable of receiving HTTP POST requests from LivePerson's Conversational Cloud. This is the location where you will receive webhook notifications.

This service should be highly available and capable of handling the volume of notifications based on your brand's expected conversation traffic, with low latency (<10ms). High latencies can cause back-pressure in notification delivery resulting in delayed notifications, and also loss of messages. We recommend that this service not perform any heavy processing for each event receive, but rather simply write the event to some internal durable message queue for another service to consume and process.

Create a Webhook Endpoint REST resource

A Webhook Endpoint REST resource needs to be created via the REST API, that encapsulates your service endpoint. This is a one-time step, however, currently this API can only be called with LivePerson internal server authorization, so please contact your Account Management team to complete this step. You will need to provide details such as the public URL of the service you set up in the previous step, retry configuration, etc. Once the webhook endpoint is set up, you can start creating Subscriptions using the REST API