Change Update - Webhooks

Following feedback we are updating our webhooks for the events messageStatusUpdate, inboundMessage and messageSend.  The messageStatusUpdate and inboundMessage will include additional fields and the messageSend will now be sent on a new type =  "messageSend".

communicationActionId: this is a unique identifier for each message.

body: this is the message content.

The Message Send webhook is also changing, this will now come as a post called messageSend rather than as one of the messageStatusUpdate posts.

Message status update - if you are subscribed to the deliveryReport event you will now receive the value communicationActionID, the messageSend events will no longer come on this webhook.

{
 "type": "messageStatusUpdate",
 "conversationId": "97847",
 "communicationActionId": "220860",
 "outboundChannelAddress": "447717472695",
 "inboundChannelAddress": "WhatsApp QA Test",
 "customerUID": "",
 "dateCreated": "2021-01-28 12:22:15.397",
 "statusCode": "2"
}

Inbound Message update - if you are subscribed to the inboundMessage event you will now receive the value communicationActionID.

Inbound Message

{
 "type": "inboundMessage",
 "conversationId": "97847",
 "communicationActionId": "220859",
 "outboundChannelAddress": "447717472695",
 "inboundChannelAddress": "WhatsApp QA Test",
 "customerUID": "",
 "body": "No I don't",
 "dateCreated": "2021-01-28 12:21:28.373"
}

Message Send update - if you are subscribed to the messageSend event you will now receive a webhook post with type = messageSend.  This will contain the comunicationActionId and the body.

{
 "type": "messageSend",
 "conversationId": "97847",
 "communicationActionId": "220860",
 "outboundChannelAddress": "447717472695",
 "inboundChannelAddress": "WhatsApp QA Test",
 "customerUID": "",
 "body": "yes",
 "dateCreated": "2021-01-28 12:22:08.377",
 "statusCode": "1"
}

This change will be deployed 3rd February 2021.  

If you have any queries please contact support@webio.com

• Related Articles

• Webio Webhooks

  Quick trick: click into organisations, scroll down to Webhooks, click create Webhook, enter the callback URL, select the events you want to subscribe to and click create. This documentation covers Webhooks creation process on on our Old UI. If you ...

• Webio Webhook - What it does

  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 identify the request as originating from Webio, first use the API to generate a JWT token. Haven't ...

• Using webhooks within your bots

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

• Generating your API key

  Quick Trick - To generate an API key within your Webio organisation, log into your organisation, click into the organisation you want to generate the key for, scroll down to the API section and click Generate Public API. 1) Click into your ...

• Creating Simple Bots

  Overview The simplest bot you can create is a one step information bot. This will send a message to the recipient. The documentation below describes how to build a Bot on our Old UI. If you are looking for our new Web App documentation please follow ...