17

JavaScript API

Last Update 21 dagen geleden

How to maximize the widget when a website loads How to maximize the widget after a trigger Delaying the tawk.to widget using JavaScript Customizing your z-index with the JavaScript API Vue 2

REST API

The instructions below are for desktops and laptops only.

tawk.to’s REST API lets you automate tasks to retrieve, create, update, and delete resources. Here are some ways you can take advantage of our REST API:

  • Automatically create properties and invite people to a property

  • Retrieve a filtered list of tickets, chats, or property members

  • Retrieve specific chat statistics filtered by agent, tag, department, and date

  • Manage webhooks

  • Create new articles, list specific articles for a property, and manage your overall Knowledge Base

  • Create and customize chat widgets 

Note:
Using REST API requires coding knowledge. If you’re unfamiliar with coding, we recommend getting a developer to write the code you need to use our REST API. Visit our developer portal for more information.

In this guide, we’ll show you how to gain access to our REST API, get an API key, and execute requests.

First, get access to our REST API

Click here to request access to our REST API. Once you have access, you’ll receive a username, password, and the link to our API documentation.


Next, let’s see how to get an API key.

Get an API key

All API requests will be authenticated using HTTP Basic Authentication.


Get access to our REST API first (if you haven’t already).


Once you’ve been granted access, follow the steps below to get a REST API key:

1. Click your profile image on the bottom left corner of your tawk.to dashboard.

2. Click Edit Profile.

3. Go to REST API Keys.

4. Click Create Key to get a new API key.

5. Your new API key will appear below.

Note: Keep your API key secure. Do not share it with unauthorized parties.
To delete a key, select the key and click Delete.

Now, let’s see how to make API requests.

Making API requests

Note: All API requests must be authenticated and made via HTTPS.

To authenticate your API requests, insert your API key as the username parameter in the HTTP authorization header. Learn more about the HTTP authorization header here.


For example:

The API consists of HTTP RPC-style methods made to the base URL: https://api.tawk.to/v1/


For example, if you want to retrieve agent details using the method /agent.me, you would perform a POST request to https://api.tawk.to/v1/agent.me


Arguments can be passed in the body of a POST request.


The response will contain a JSON object with a top-level boolean property, indicating whether the response was successful or not. For unsuccessful results, the error property contains a short machine-readable error code.


Ask our developers' community if you have questions about using our REST API.

If you have feedback about this article, or if you need more help:

Was this article helpful?

63 out of 92 liked this article

Still need help? Message Us