Outgoing Webhooks

Outgoing Webhooks

By setting up Outgoing Webhooks, you can send notifications to an external service whenever a specified action occurs.

What is a Webhook?

A webhook is a mechanism that allows you to call functions on external services via the internet using HTTP/HTTPS and a URL (utilizing a Web API).

Web API

A Web API is an API that can be accessed over the internet.
You can send commands to the API via an HTTP/HTTPS URL.
It serves as a bridge that connects web-based services with each other.

Calling a Web API via Webhook

Call Process

Use HTTP to send the Web API URL along with the required parameters (data).
When sending data to the server, include the data in the request body.
HTTP POST: Used to write/send data.
HTTP GET: Used to retrieve data.

When using GET, the data is appended to the request URL as follows: http://example.com/foo?name1=value1&name2=value2


Authentication

If accessing data on the receiving side, authentication (such as end-user login or server login) must be considered in the design.
When calling a login Web API via Webhook, the design must be tailored based on the external service’s specific requirements.


Response

The target server returns data as a response.
Data format: JSON


Add a New Outgoing Webhook

Go to [Settings] → [Outgoing Webhooks].

[Add] a New Outgoing Webhook

Then fill in the fields according to the table below.




Title
Content
Details

Title
Set any desired title.

Type

New User Message (OP Mode Only)
Notification will be sent when a new message requiring operator response is received from a customer.

New Concierge Reply
Notification will be sent when the property side sends a reply.

Agreed to Terms of Use
Notification will be sent when a customer agrees to the terms of use, if the property is configured to request agreement before using the chatbot for the first time.

New Chat Created (New User)
Notification will be sent when a new user is added. This is only available for properties using [Membership (Chatbot)] under [Authentication].

Authentication Failed (Custom Auth Only)
Notification will be sent when authentication fails. This is only available for properties using [Custom Authentication] under [Authentication].

Send API Request
GET/POST
Refer to the documentation of the target URL and set accordingly.

Request URL
Enter the destination URL to which the API request will be sent.

Header
May not be required.
Please refer to the documentation of the target URL and enter only if necessary.

Parameter
Displayed only for GET requests.
Refer to the documentation of the target URL and enter as needed.

Body
Displayed only for POST requests.
Enter the data to be sent in JSON format.

    • Related Articles

    • Setting Up Chatbot Webhook

      What Is a Webhook? A webhook is a mechanism that calls external services over the internet using HTTP/HTTPS URLs (i.e., via a Web API). WebAPI An API made accessible over the internet. You can send commands to the API via an HTTP/HTTPS URL. It ...