Open API

Introduction

Open API is built around GraphQL.

Open API is built around GraphQL. It is recommended to have prior knowledge of GraphQL in order to make use of the Open API.

You can visit our Open API Playground, where you can test our Open API. For your reference, API Documentation and Schema are also available at the right side of the playground.

Open API Playground

Endpoint URL

Please use the following Endpoint URL for Open API: https://open.api.woztell.com/v3

Authentication

1. Follow this guide to generate an access token from your WOZTELL app.

2. In the Open API playground, insert the access token into the HTTP HEADERS.

{
"Authorization": " Bearer [access_token]"
}

Open API Playground

How to test our API calls?

1. Write your query on the left panel. You can try with the following call to get conversation history.

query getChatHistory ($first: IntMax100) {
  apiViewer {
    conversationHistory (first: $first) {
      edges {
        node {
          messageEvent
        }
      }
    }
  }
}

2. You can refer to the SCHEMA and DOCS for other query types.

API Docs

API Schema

3. Varaiables can be entered in the QUERY VARIABLES.

Query Variables

4. Click the button to test the API call, the response will be displayed on the right panel.

API call sent

Rate Limit

There are rate limits on our API calls. After sending an API call to WOZTELL with GraphQL Client (e.g. Postman), you can view the rate limit in Response Headers:

X-RateLimit-Remaining: The count of API calls that you can send in a minute

X-RateLimit-Limit: The count of API calls sent in a minute

Retry-After: The time needed until the next call after reaching the rate limit (in seconds)

Response Headers

---

Changelog

(Last Updated: 16/8/2021)

New API

10 New API have been added under apiViewer. Please use https://open.api.woztell.com as the endpoint URL.

New api under apiViewer
actions
audiences
conditions
localeGroups
nodes
priorityGroups
responses
subscriptionPushes
trees
triggers

New Mutations

53 New Mutations have been added. Please use https://open.api.woztell.com as the endpoint URL.

New Mutations
createDataSourceDoc	importTrees	updateCondition	deleteAudience	updatePriorityGroup	importMembers
updateDataSourceDoc	duplicateTree	deleteCondition	createChannel	deletePriorityGroup	createNode
deleteDataSourceDocs	createResponse	createAction	updateChannelPriorityGroup	updateSubscriptionPush	updateNode
importDataSource	updateResponse	updateAction	updateChannel	deleteSubscriptionPush	deleteNode
createDataSource	deleteResponse	updateAction	deleteChannel	updateAgenda	updateAppIntegration
updateDataSource	deleteResponse	deleteAction	createMember	deleteAgenda
deleteDataSource	createTrigger	updatePairsInApp	updateMember	exportChats
createTree	updateTrigger	addOutletInPair	deleteMember	createLocaleGroup
updateTree	deleteTrigger	createRetryAudience	updateMembers	updateLocaleGroup
deleteTree	createCondition	updateAudience	createPriorityGroup	deleteLocaleGroup