How to configure a Webhook
Overview
Using the Webio webhook, you can configure endpoints within your Webio organization to post or retrieve data. Webhooks can be used to:
1) Receive notifications (Post Request) from your organization to your internal system, whenever an event that you subscribe to in Webio occurs. Set up multiple endpoints within your Webio organization, choose which events to subscribe to, and verify their connections during the setup process.
2) Receive GET Requests from Webio: Enrich bot conversations with contact information from your internal system: Some bots request data from your system in real-time. These can be used to enrich incoming conversations with account data or to include real-time data from your internal system.
How to configure a Webhook
To identify the request as originating from Webio, first use the API to generate a JWT token.
To configure a Webhook for your Organization:
- Log in to Webio, click Settings, and then click Organizations.
- Select the organization for which you want to configure the Webhook, click EDIT then INTEGRATIONS.
- From the integrations section, scroll down to the Webhook, then click ADD WEBHOOK.
You should see the box below. Enter the Callback URL you want us to connect to and click which events you will subscribe to. A Callback URL is a URL provided by the receiving application, and acts as a destination for the webhook to send the event data.
Webio has standard webhooks available for you to subscribe to, several post requests and 1 get request.
Post requests
- Inbound messages - Message details and content of an inbound message received to a channel id assigned to your organisation.
- Message Send - A message status update to confirm a message state has moved from pending to sent.
- Delivery Report - A message status update to confirm a message state has moved from a sent status to an outcome status.
- Payment - Confirmation details of any successful payment made via WebioPay will be returned to your endpoint.
- setStatus - Receive an update to confirm a status has been assigned to a conversation.
- conversationClosed - Receive an update to confirm a conversation has been closed.
- move to queue - Receive an update to confirm a conversation has been moved to a queue.
- conversation assignment - Receive an update about conversation assigned/unassigned.
Further details here - Change Update - Webhooks
Get request
- Custom Value Request: This requests information from your system to update values used within the bot webhook fields <<>>
- Webio will send a request to the endpoint configured within your organisation. The request will contain the Customer ID (this is a null value for inbound initiated conversations), the channel id (e.g. phone number) and the field names of the parameters requested. This can be used to update message content with real time information such as current balance requests, or provide data that the bot can use for identification and verification.
Test the connection
To test the connection, from the integration panel, scroll down to the webhook section, find the webhook you just created and click 'Test'.
Webio provides you 5 tests that can be run from the organization screen. Select the test you wish to run from the drop down menu.
To add custom values into your bots via the Webhook, insert the <<fieldname>> where you want them to appear. This can be within the message content or within the Logical Branch condition step.
For custom value retrieval only one Webhook endpoint can be used per organisation.
Related Articles
How to add custom fields names
Overview When you build the Campaign File, you create field names (the column headers of your campaign file) and then you store custom values against the contact channel ID (On the same row where the contact's identification channel/customer ID has ...API and Webhooks
Overview Webio blended conversations allow you to seamlessly communicate between your clients with human or automated agents. Connecting these conversations with your internal systems provides richer conversations and slicker processes. API Requests ...Setup your Organization
Overview To access the Organizations screen, from the navigation panel on the left-hand side, click on Settings, then Organizations; From here you can control your organization's settings and all your sub orgs. When you create a new organization or ...How to add an SFTP to your Organization
Overview Webio enables SFTP implementation for your organization. SFTP (Secure File Transfer Protocol) is a file transfer protocol that uses SSH encryption to transfer files between systems securely. Connecting via SFTP allows you to access API ...SFTP Hooks
You can now use Webio SFTP hooks to combine the power of webhook realtime posts and SFTP file transfers to deliver webhook calls as JSON files to your organisation's Webio SFTP folder for retrieval. You will need to configure your Webio SFTP and ...