Webio Webhook - What it does (New Web App)

Webio Webhook - What it does (New Web App)

Overview

Using Webio's webhook you can configure your endpoints within your Webio organisation to post or retrieve data.
Identifying the request is from us
To generate the JWT header you need the api key from your Webio organisation, your secret key (this must be a minimum of 32 bytes) and your organisation ID.  Once created this will then be included with every event until the a new JWT token is generated.  
Once generated all requests from Webio will then contain this token within the header x-webio-token.  This enables you to verify that the request is originating from Webio. The Webio token can be regenerated as often as you wish and the latest token will be provided within a request. 

Subscribing to events


Webio has 9 standard webhooks available for you to subscribe to, 8 post requests and 1 get request.

Post requests

  1. Inbound messages - Message details and content of an inbound message received to a channel id assigned to your organisation.
  2. Message Send - A message status update to confirm a message state has moved from pending to sent.
  3. Delivery Report - A message status update to confirm a message state has moved from a sent status to an outcome status.
  4. Payment - Confirmation details of any successful payment made via WebioPay will be returned to your endpoint.
  5. setStatus - Receive an update to confirm a status has been assigned to a conversation.
  6. conversationClosed - Receive an update to confirm a conversation has been closed.
  7. move to queue - Receive an update to confirm a conversation has been moved to a queue.
  8. conversation assignment - Receive an update about conversation assigned/unassigned.

Get request

This requests information from your system to update values used within the bot webhook fields <<>>
  1. Custom Value Request - Webio will send a request to the endpoint configured within your organisation.  The request will contain the Customer UID (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 compare gathered data with the ones stored on your internal system and that the bot can use for identification and verification. - Webhooks within your-bots
Example of get request sent to your system:
https://sampleendpoint/Users?customerUID=123456&outboundChannelAddress=44777777777&param1=balance&param2=ID
This is made up of: 
  1. https://sampleendpoint.com/Users - the webhook base url endpoint configured in your Webio Organisation
  2. ?customerUID=123456&outboundChannelAddress=44777777777 - information from the contact
  3. &param1=balance&param2=ID - parameter requested (Fieldnames)& configured as webhook values <<>> within the bot steps
The parameters requested will be dependent on what is configured at that stage within the bot.  This may just be one parameter or multiple parameters.  
Currently for inbound communications only the outboundChannelAddress will be populated.  The customerUID field will be null but you can ask via Listening Step. The field names are configured within the bot and identified with <<fieldname>>, these can be set by Webio users in the bot messages.   

Getting started
To see exactly how to add your webhooks into your Webio organisation check out the article Adding Webhooks

    • Related Articles

    • How to configure a Webhook

      Overview Using the Webio webhook, you can configure endpoints within your Webio organization to post or retrieve data, so you can: Receive notifications (Post Request) from your organization to your internal system, whenever an event that you ...

    • Webhooks within your bots (New Web App)

      Overview Webhooks allow you to use real time information within your Webio bots. This can be used to provide customers' up to date information within the conversation or to configure logic decisions within your bot based on information provided from ...

    • 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. For a better ...

    • Listening Steps To Gather Data (New Web App)

      Overview The Listening steps can be used to gather responses and store them in either Data fields or in Customer ID fields. If you store the response as a Customer ID then that value will display in the conversation screen and in reports and webhooks ...

    • New Releases

      This article will be continuously updated with the latest release information. 02/06/25 - Insights V2.0 We're excited to announce the launch of Insights V2.0, a revolutionary upgrade to our analytics platform that transforms how you interact with ...