Parameter `WEBHOOKS`¶

Paid Access

Using this parameter is only available for Hotline premium users. To purchase a paid version of the system, contact our support service.

The parameter sets one or more addresses for processing incoming webhooks from Hotline for a given list of events.

Webhooks are sent using the POST method with request body in JSON format.

Event Types¶

1. System Events¶

Available values: dialog_created, dialog_reopened, dialog_closed, message_received, message_sent, message_intercepted.

Webhooks for such events do not return results to the backend group.

2. Custom Commands¶

Any custom or already existing system command can be specified. Command name must start with slash /.

Webhooks for such events can return results to the backend group as a message.

For more details about the format of sent requests, see Webhooks format description.

By default, the list is empty, webhooks are not sent anywhere.

Data Format¶

Webhook configuration is set in JSON format.

To clear the parameter, send the value OFF

The setup bot needs to be sent the required value after selecting the parameter for editing.

Default Value¶

NONE

Usage Examples¶

{
  "https://someapiserver.com/webhooks/end_point-1": [
    "dialog_created",
    "dialog_reopened",
    "dialog_closed",
    "message_received",
    "message_sent",
    "message_intercepted"
  ],
  "https://someapiserver.com/webhooks/end_point-2": [
    "/mark", "/info",
    "/invoice", "/client"
  ]
}

Result: all system events will come to end_point-1, and events about called commands will go to end_point-2.

Main Use Cases¶

external integrations
custom analytics

Parameter WEBHOOKS¶