Custom Channel Quick Start
Integrate third-party messaging app into IS Messenger
Last updated
Integrate third-party messaging app into IS Messenger
Last updated
Step 1: Go to Settings > Channels
Step 2: Click Add Channel > Custom Channel > Connect
Step 3: Enter the destination Webhook URL where outgoing messages will be sent.
Step 4: Select the ID type for the Channel > click Next
ID types are used for user identification and are used to communicate with your custom integration server.
There are two types of IDs available:
Phone Number: Use this if the messaging service provider recognizes Contacts based on their Phone Number.
Sample format: +60177872890
Custom ID: Use this if the messaging service provider recognizes Contacts based on a custom-generated ID.
The maximum character length is 50.
A-Z
, a-z
, 0-9
, _
, =
, +
, /
and @
are allowed.
Step 5: The following dialog will provide the Channel ID, API Token, and Webhook URL e.g.
Channel ID: gfd8g7fd89dgfd
API Token: aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd
Webhook URL: https://app.
IS-Messenger/custom/channel/webhook/
Using a Phone Number ID type allows you to initiate a conversation and send the first message to a Contact.
Pass Messages to IS-Messenger
Webhook URL is used to post the Messages, Messaging Echoes and Messaging Receipts to the IS-Messenger platform.
The provided code will trigger the webhook on IS-Messenger, creating a Contact if necessary and saving the message under that Contact.
Sample for Messages
Sample for Messaging Echoes
Sample for Messaging Receipts
Response - Success (HTTP status → 200)
Handle Outgoing Messages from IS-Messenger
IS-Messenger will call the endpoint <API Base URL>/message
Ensure you apply the Outgoing Message code on the /message
route of your web server.
Here is the cURL example of IS-Messenger calling the endpoint:
Response - Success (HTTP status → 200)
Authentication needs to happen at the endpoint before sending the message to the Messaging Service Provider.
Here's an example of using an express middleware for this purpose:
We've included an example of a Custom Channel you can test on your server. Check out our GitHub project here.
Messages Type
Sample for Text
Sample for Media File
Ensure that the attachment URL isn't forcibly downloaded by the browser. The HTTP response's Content-Disposition
header should have the default value, which is inline
.
Sample for Location
Sample for Quick Reply
Error (HTTP Status → 4xx)
Step 1: Click Settings > Channels
Step 2: Locate the Custom Channel > click Manage
Step 3: In the Custom Channel Configuration page you will see the following configurations:
Channel Icon - Upload an image that serves as the icon for your Custom Channel.
Channel Name - The Channel Name can be changed and is used internally to identify the Channel.
Webhook URL for Outgoing message — The webhook URL for outgoing messages to this Channel.
Webhook URL for Incoming message — The webhook URL for incoming messages to this Channel.
ID Type — These are used for user identification and are used to communicate with your custom integration server.
Channel ID — Unique Channel ID to identify your Custom Channel.
API Token — A unique identifier used to authenticate a user to access an API.
Step 4: Click Save Changes to update the Custom Channel configuration.
Can I connect chats from other platforms using a Custom Channel?
Yes, you can. Here are three steps to follow:
In IS-Messenger, input the destination webhook URL from the other platform into the Webhook URL for Incoming message field.
In the other platform, set up a webhook URL pointing to IS-Messenger, allowing Contacts to send messages back to you.
You'll require a Custom Integration Server to interpret APIs from both IS-Messenger and the other platform, enabling message exchange between them.
Make sure to confirm with the other platform that the first two steps are feasible.