HTTP API

Brand developers who are unable to use the Alcmeon builtin Javascript SDK or iframe-based widget can take advantage of our HTTP-based API to re-implement entirely the user interface presented to customers. In this context, the right deployment scenario involves the following steps:

  1. Generate an authentication JWT which contains a unique stable customer id which can be used to send notifications to customers.
  2. Exchange the authentication JWT against an AlcmeonChat JWT with the POST /authenticate endpoint. From now on, all HTTP endpoints are authenticated with the AlcmeonChat JWT returned from this last endpoint.
  3. Read the most recent messages exchanged with the user GET /{page_id}/conversation
  4. When the user types a message, POST /{page_id}/conversation to send it
  5. When a customer support agent or a bot replies, Alcmeon sends a webhook via the Webhook API. Read the action.task.message.author.inmessage_author.customer_id field, and then, send a notification to the device id associated with this customer_id.
  6. When you receive a notification on the user's device about a new reply from an agent, or a bot, update the status of the conversation via GET /{page_id}/conversation .