Generating your API key

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 organisation and scroll down to the API section.  Under Public API Key click GENERATE.



2) The warning message below will be displayed, once you have read it, to continue, click GENERATE.



3) The API Key will be displayed.  This will remain valid against your organisation until it is deleted. Click CANCEL to close the message.  Your API Key is now stored against your organisation.

 

To send outbound conversations via the API you will also require a schedule ID that is associated with your organisation.  This can be retrieved from the campaign summary report within the reporting section.


    • Related Articles

    • 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 ...

    • 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 ...

    • 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 =  ...

    • 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 ...

    • How to Setup a SFTP (Classic Web App)

      SFTP is a secure method of transferring data. Connecting via SFTP allows you to access API services as detailed in our Swagger document, or retrieve reports. If you want to connect to Webio using SFTP then you can configure an SFTP connection for ...