Register a webhook

Admins of your organization, from a signed-in session in the mlivechat app; a bot token can't call it.

We make the signing secret and answer it once, in secret_key: check each delivery with it.

POST/v1/configuration/action/register_webhook

POST /v1/configuration/action/register_webhook HTTP/1.1
Host: app.mlive.chat
Content-Type: application/json

{
  "url": "https://crm.northwind.example/hooks/chats",
  "action": "incoming_chat"
}

Response200

{
  "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
  "secret_key": "whsec_9f2c4e1a7b"
}

Specifics

Method URL	`POST https://app.staging.mlive.chat/v1/configuration/action/register_webhook`
Who can call it	Admins of your organization, from a signed-in session in the mlivechat app; a bot token can’t call it. Most teams use Settings, Webhooks instead.

Request body

application/json

urlstring (uri)required
Https and a public address.
actionWebhookActionrequired
One of incoming_chat, incoming_event, chat_deactivated, chat_transferred, thread_tagged, routing_status_set, customer_visit_started.
descriptionstring
Up to 200 characters.
typestring
One of license. Default "license".

Response

200 · application/json

OK.

idstringrequired
secret_keystringrequired
Shown once.

Errors

default