API and Webhooks

API and Webhooks

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

Using Webio published APIs you can automate instructions from your internal systems to your Webio organisation.
You may want to start a conversation, send a message to an existing conversation or retrieve the conversation transcripts. 

Typically a technical resource on your side will be required to set up the requests from your internal systems but Webio allows you to minimise the resource required.

You can generate your API key from your Webio login and use our published API to configure the business process you require. 

More Technical?  Check out our API pack.


 Get Requests

If your conversation needs a piece of real time information, use <<fieldname>> within your message or logical values and the bot will reach out to your internal systems (endpoints) to request that information. 

This can be used for providing balance or accounts updates, completing verification checks or ensuring that your bot has the latest information to provide to the customer or determine what to do next.

Post Requests

Post Requests update your internal systems and are triggered when an event you are subscribed to, happens.

This can be a message being sent or received, a payment being made or a delivery report being received.

We will be announcing additional events and API enhancements over the next few months.

Ready to go?

For API Requests you will probably want to show this to your technical team.  They will be able to connect to our published API.  When they are ready, you can generate your API key from within your organisation screen.

Tell me how: Generate API Key

For the webhook you will want to ask your technical team what the necessary endpoint is.  We can post to multiple systems (endpoints) for each of your Webio organisations but we can only come to one system (endpoint) to get information from you.

Once you have the endpoint, add it to your organisation screen, select the events you want to subscribe to (these are the things that happen that trigger request) and your webhooks are ready to go.

Tell me how: Setup Webhooks

If you are using the Get request to enrich your bot conversations, you will need to use <<fieldname>> within your bot where you want the information to be inserted. 

Tell me how: Webhooks Within Bots

    • 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.   Some bots require data from your system in real-time.  This can be used to ...
    • 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 =  ...
    • 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 ...
    • 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 ...
    • 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 ...