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
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.
Webhook Connectivity
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.
For 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
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 ...Generate an Api key for your organization
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. Using Webio ...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 ...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 ...Webio FAQ
General Why can't I log to my Webio account? If you can't log to your Webio Account, try first to clear your internet browser cache and cookies or to log in from incognito window or a different internet browser (Make sure you are entering your ...