14

JavaScript

Last Update vor einem Monat

How to maximize the widget when a website loads How to maximize the widget after a trigger Customizing your z-index with JavaScript Vue 2 React.js

REST API

The instructions below are for desktops and laptops only.

The tawk.to REST API lets you automate and manage many aspects of your account, streamlining tasks and integrating tawk.to with your existing systems.


You can use the REST API to:


  • Create properties and invite team members automatically

  • Retrieve filtered lists of tickets, chats, or property members

  • View chat statistics by agent, tag, department, and date

  • Manage webhooks

  • Create and list Knowledge Base articles

  • Create and customize chat widgets


Note: The REST API is designed for developers or anyone comfortable working with code. If you’re new to APIs, consider working with a developer.


For technical references and updates, visit the tawk.to Developer Portal.


To learn more about using webhooks, see this guide:

Creating and managing Webhooks

First, request access to the REST API

The REST API is available by request. To get started:


  1. Fill out the REST API Access Request Form.

  2. Once your request is approved, you’ll receive a username, password, and a link to the REST API documentation.

Create an API key

After you’ve received REST API access:


1. Log in to your tawk.to account.


2. Click your profile image in the lower-left corner of your Dashboard.

3. Click Edit Profile.

4. Click REST API Keys in the left menu.

5. Click Create Key.

6. Your new key will appear in the list.

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

Authenticate your requests

All REST API requests must:


  • Use HTTPS


  • Use HTTP Basic Authentication with your API key as the username in the Authorization header


How you set this up depends on your HTTP client or programming language. Most have built-in support for Basic Authentication.


Learn more about the HTTP authorization header here.

Base URL and method style

Base URL: https://api.tawk.to/v1/


The REST API uses HTTP RPC-style methods. Pass parameters in the body of POST requests unless otherwise noted in the documentation.

Example request

Get the current agent’s details


  • Endpoint: POST https://api.tawk.to/v1/agent.me


  • Authentication: HTTP Basic (API key as username)

  • Response: JSON with a success indicator; errors include a short error code.

Handling responses and errors

  • Successful requests return JSON with a clear success indicator.

  • If something goes wrong, the response will include an error code you can use to debug or handle the issue.


Check your REST API documentation for the full list of methods, parameters, and error codes.


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

Important considerations

  • Security
    Store your API keys securely and rotate them regularly.

  • Testing
    Try your requests in a staging environment before making changes in production.

  • Error handling
    Plan for retries with backoff in case of temporary issues.

  • Webhooks
    Validate incoming payloads to confirm requests are genuine.

  • Alternatives
    If you only need to customize the widget on your site, the JavaScript API may be simpler than the REST API.

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

Was this article helpful?

78 out of 113 liked this article

Still need help? Message Us