tawk.to

App · 20 actions

Work with your tawk.to live chat, tickets and help center: read chats and their transcripts, tickets and chat statistics, write knowledge base articles, and start a workflow when a chat starts or ends or a ticket comes in.

Actions

ActionWhat it does
Create articleWrite a knowledge base article, as a draft unless you publish it.
Create article categoryAdd a knowledge base category to file articles under.
Delete articleDelete a knowledge base article.
Delete article categoryDelete a knowledge base category.
Find articlesList the knowledge base's articles, or find those matching words, with their status and feedback.
Get articleGet a knowledge base article with its title, text, status and feedback.
Get chatGet one chat with its whole transcript: who said what, and when.
Get chat statisticsGet a property's chat statistics day by day: chats, missed chats, messages, ratings, response time and duration.
Get my profileGet the tawk.to agent whose API key the connection uses.
Get ticketGet one ticket with its subject, message, status and requester.
Get ticket statisticsGet a property's new, reopened or resolved tickets, or ticket responses, day by day.
List article categoriesList the knowledge base's categories with how many articles each holds.
List chatsList a property's chats, newest first, with each chat's messages and transcript.
List contact attributesList the custom attributes a property's contacts (people or organizations) have.
List knowledge base sitesList the property's knowledge base sites, one per language.
List membersList the agents and admins of a property.
List propertiesList the properties (websites and pages with the chat widget) your account belongs to, with their ids.
List ticketsList a property's tickets, newest first, with subject, status, requester and assignee.
List webhooksList the webhooks set up on a property: where each posts and for which events.
Update articleChange a knowledge base article's title, text, subtitle, status, visibility or category; the rest stays as it is.

Create article

Write a knowledge base article, as a draft unless you publish it.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
TitletitletextRequired
The article's title.
TexttexttextRequired
The article. Separate paragraphs with a blank line, or give HTML (starting with <) for headings, links and lists.
Knowledge base sitesite_idtext
The site (one per language). Leave empty for the main site.
Subtitlesubtitletext
A line under the title.
Statusstatustext
Draft keeps it hidden until you publish it.One of: draft, published, archived. Default: draft.
Visibilityvisibilitytext
Public articles show to everyone; private ones only to your team.One of: public, private. Default: public.
Categorycategory_idtext
The category to file it under.
Web addressslugtext
The last part of its web address, such as install-the-widget. Made from the title when empty.

Outputs

articleobject
The article
summarytext
One line saying what was found or done
Example output
{
  "article": {
    "author": "666668688fe587223fdf8685",
    "blocks": [
      {
        "content": {
          "heading": "h2",
          "text": "<p>Before you start</p>"
        },
        "type": "header"
      },
      {
        "content": {
          "text": "<p>Copy the widget code from <b>Administration</b>.</p>"
        },
        "type": "paragraph"
      }
    ],
    "category_ids": [
      "6672b1c0c3e5a8b1d2e4f710"
    ],
    "created_at": "2026-06-05T10:00:00.000Z",
    "downvotes": 1,
    "id": "6672b2a0c3e5a8b1d2e4f777",
    "site_id": "primary",
    "slug": "install-the-chat-widget",
    "status": "draft",
    "subtitle": "Add tawk.to to your site in five minutes",
    "text": "Before you start\n\nCopy the widget code from Administration.",
    "title": "Install the chat widget",
    "updated_at": "2026-06-06T09:30:00.000Z",
    "upvotes": 4,
    "visibility": "public"
  },
  "summary": "Created the article Install the chat widget"
}

Create article category

Add a knowledge base category to file articles under.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
NamenametextRequired
The category's name.
Knowledge base sitesite_idtext
The site (one per language). Leave empty for the main site.
Descriptiondescriptiontext
A line about what it holds.
Inside categoryparent_idtext
Put it inside this category. Leave empty for the top level.

Outputs

categoryobject
The category
summarytext
One line saying what was found or done
Example output
{
  "category": {
    "article_count": 3,
    "created_at": "2026-06-05T09:00:00.000Z",
    "description": "First steps",
    "id": "6672b1c0c3e5a8b1d2e4f710",
    "name": "Getting started",
    "parent_id": "",
    "position": 0,
    "slug": "getting-started",
    "updated_at": "2026-06-05T09:00:00.000Z"
  },
  "summary": "Created the category Getting started"
}

Delete article

Delete a knowledge base article. tawk.to keeps it recoverable unless you delete it for good.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Article IDarticle_idtextRequired
The article's id, from 'Find articles' or 'Create article'.
Delete for goodpermanentlytrue/false
Delete it permanently instead of keeping it recoverable in tawk.to.Default: false.

Outputs

article_idtext
The deleted article's id
deletedtrue/false
Always true once deleted
permanentlytrue/false
Whether it was deleted for good rather than kept recoverable
summarytext
One line saying what was found or done
Example output
{
  "article_id": "6672b2a0c3e5a8b1d2e4f777",
  "deleted": true,
  "permanently": false,
  "summary": "Deleted the article 6672b2a0c3e5a8b1d2e4f777"
}

Delete article category

Delete a knowledge base category. tawk.to keeps it recoverable unless you delete it for good.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Categorycategory_idtextRequired
The category to delete. Pick one, or give its id.
Delete for goodpermanentlytrue/false
Delete it permanently instead of keeping it recoverable in tawk.to.Default: false.

Outputs

category_idtext
The deleted category's id
deletedtrue/false
Always true once deleted
permanentlytrue/false
Whether it was deleted for good rather than kept recoverable
summarytext
One line saying what was found or done
Example output
{
  "category_id": "6672b1c0c3e5a8b1d2e4f710",
  "deleted": true,
  "permanently": false,
  "summary": "Deleted the category 6672b1c0c3e5a8b1d2e4f710"
}

Find articles

List the knowledge base's articles, or find those matching words, with their status and feedback.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Words to findsearchtext
Only articles with these words. Leave empty for every article.
Knowledge base sitesite_idtext
The site (one per language). Leave empty for the main site.
Statusstatustext
Only articles in this state.One of: draft, published, archived.
Categorycategory_idtext
Only articles in this category.
Ordersorttext
The order to list them in, when not finding words.One of: updated (Last updated first (default)), created (Newest first), title (Title, A to Z). Default: updated.
How manylimitnumber
How many articles to return (1 to 50).From 1 to 50. Default: 25.
Next pagepage_tokentext
For the next page: the next_page_token of the step before.

Outputs

articleslist
The articles
countnumber
How many are returned
has_moretrue/false
Whether there are more after these
next_page_tokentext
Reads the next page; empty when there is none
summarytext
One line saying what was found or done
totalnumber
How many there are in all
Example output
{
  "articles": [
    {
      "category_ids": [
        "6672b1c0c3e5a8b1d2e4f710"
      ],
      "created_at": "2026-06-05T10:00:00.000Z",
      "downvotes": 1,
      "id": "6672b2a0c3e5a8b1d2e4f777",
      "site_ids": [
        "primary"
      ],
      "status": "draft",
      "title": "Install the chat widget",
      "updated_at": "2026-06-06T09:30:00.000Z",
      "upvotes": 4,
      "visibility": "public"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page_token": "",
  "summary": "1 article",
  "total": 1
}

Get article

Get a knowledge base article with its title, text, status and feedback.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Article IDarticle_idtextRequired
The article's id, from 'Find articles' or 'Create article'.
Knowledge base sitesite_idtext
The site (one per language). Leave empty for the main site.

Outputs

articleobject
The article
summarytext
One line saying what was found or done
Example output
{
  "article": {
    "author": "666668688fe587223fdf8685",
    "blocks": [
      {
        "content": {
          "heading": "h2",
          "text": "<p>Before you start</p>"
        },
        "type": "header"
      },
      {
        "content": {
          "text": "<p>Copy the widget code from <b>Administration</b>.</p>"
        },
        "type": "paragraph"
      }
    ],
    "category_ids": [
      "6672b1c0c3e5a8b1d2e4f710"
    ],
    "created_at": "2026-06-05T10:00:00.000Z",
    "downvotes": 1,
    "id": "6672b2a0c3e5a8b1d2e4f777",
    "site_id": "primary",
    "slug": "install-the-chat-widget",
    "status": "draft",
    "subtitle": "Add tawk.to to your site in five minutes",
    "text": "Before you start\n\nCopy the widget code from Administration.",
    "title": "Install the chat widget",
    "updated_at": "2026-06-06T09:30:00.000Z",
    "upvotes": 4,
    "visibility": "public"
  },
  "summary": "Article: Install the chat widget"
}

Get chat

Get one chat with its whole transcript: who said what, and when.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Chat IDchat_idtextRequired
The chat's id, from 'List chats' or a chat trigger.

Outputs

chatobject
The chat
summarytext
One line saying what was found or done
Example output
{
  "chat": {
    "created_on": "2026-06-28T14:03:04.646Z",
    "id": "70fe3290-99ad-11e9-a30a-51567162179f",
    "message_count": 3,
    "messages": [
      {
        "attachments": [],
        "sender_id": "",
        "sender_name": "Customer Support",
        "sender_type": "system",
        "text": "Hi! How can we help?",
        "time": "2026-06-28T14:03:04.646Z",
        "type": "msg"
      },
      {
        "attachments": [],
        "sender_id": "",
        "sender_name": "",
        "sender_type": "visitor",
        "text": "Where is my order?",
        "time": "2026-06-28T14:03:20.176Z",
        "type": "msg"
      },
      {
        "attachments": [
          {
            "mime_type": "image/png",
            "name": "receipt.png",
            "size": 3797,
            "url": "https://tawkto.link/files/receipt.png"
          }
        ],
        "sender_id": "666668688fe587223fdf8685",
        "sender_name": "Eugene",
        "sender_type": "agent",
        "text": "It ships today. Here is the receipt.",
        "time": "2026-06-28T14:04:02.780Z",
        "type": "msg"
      }
    ],
    "property_id": "58ca8453b8a7e060cd3b1ecb",
    "status": "closed",
    "tags": [
      "billing"
    ],
    "transcript": "Customer Support: Hi! How can we help?\nMartins: Where is my order?\nEugene: It ships today. Here is the receipt.",
    "updated_on": "2026-06-28T14:09:12.120Z",
    "visitor_email": "hello@example.com",
    "visitor_name": "Martins"
  },
  "summary": "Chat with Martins, 3 messages"
}

Get chat statistics

Get a property's chat statistics day by day: chats, missed chats, messages, ratings, response time and duration.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Fromfrom_datedate
The first day counted. Defaults to six days before To.
Toto_datedate
The last day counted (UTC). Defaults to today.
Measuresmeasureslist
What to count. Leave empty for all of them.One or more of: total (Number of chats), missed (Missed chats), messages, ratings, responseTime (Response time), duration (Chat duration).

Outputs

countnumber
How many are returned
from_timetext
The first moment counted (ISO 8601, UTC)
rowslist
The statistics: one row per day, or a single row for the whole period
summarytext
One line saying what was found or done
to_timetext
The last moment counted (ISO 8601, UTC)
Example output
{
  "count": 1,
  "from_time": "2026-06-22T00:00:00Z",
  "rows": [
    {
      "date": "2026-06-28",
      "messages": 140,
      "missed": 1,
      "total": 12
    }
  ],
  "summary": "Chat statistics from 2026-06-22 to 2026-06-28",
  "to_time": "2026-06-28T23:59:59Z"
}

Get my profile

Get the tawk.to agent whose API key the connection uses.

Inputs

None.

Outputs

agentobject
Your agent profile, as tawk.to returns it
summarytext
One line saying what was found or done
Example output
{
  "agent": {
    "email": "eugene@example.com",
    "id": "666668688fe587223fdf8685",
    "name": "Eugene"
  },
  "summary": "Signed in as Eugene"
}

Get ticket

Get one ticket with its subject, message, status and requester.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Ticket IDticket_idtextRequired
The ticket's id (not its number), from 'List tickets' or a ticket trigger.

Outputs

summarytext
One line saying what was found or done
ticketobject
The ticket
Example output
{
  "summary": "Ticket #3 Refund for order 1042",
  "ticket": {
    "assignee_name": "Eugene",
    "created_on": "2026-06-28T14:07:13.512Z",
    "human_id": 3,
    "id": "02598050-99ae-11e9-8887-97564881b95b",
    "message": "The parcel arrived damaged.",
    "property_id": "58ca8453b8a7e060cd3b1ecb",
    "requester_email": "martins@example.com",
    "requester_name": "Martins",
    "status": "open",
    "subject": "Refund for order 1042",
    "tags": [
      "refund"
    ],
    "updated_on": "2026-06-28T15:30:00.000Z"
  }
}

Get ticket statistics

Get a property's new, reopened or resolved tickets, or ticket responses, day by day.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Measuremeasuretext
What to count.One of: new (New tickets), reopened (Reopened tickets), resolved (Resolved tickets), responses (Ticket responses). Default: new.
Fromfrom_datedate
The first day counted. Defaults to six days before To.
Toto_datedate
The last day counted (UTC). Defaults to today.

Outputs

countnumber
How many are returned
from_timetext
The first moment counted (ISO 8601, UTC)
measuretext
What was counted
rowslist
The statistics: one row per day, or a single row for the whole period
summarytext
One line saying what was found or done
to_timetext
The last moment counted (ISO 8601, UTC)
Example output
{
  "count": 1,
  "from_time": "2026-06-22T00:00:00Z",
  "measure": "new",
  "rows": [
    {
      "date": "2026-06-28",
      "total": 4
    }
  ],
  "summary": "New tickets from 2026-06-22 to 2026-06-28",
  "to_time": "2026-06-28T23:59:59Z"
}

List article categories

List the knowledge base's categories with how many articles each holds.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.

Outputs

categorieslist
The categories
countnumber
How many are returned
summarytext
One line saying what was found or done
Example output
{
  "categories": [
    {
      "article_count": 3,
      "created_at": "2026-06-05T09:00:00.000Z",
      "description": "First steps",
      "id": "6672b1c0c3e5a8b1d2e4f710",
      "name": "Getting started",
      "parent_id": "",
      "position": 0,
      "slug": "getting-started",
      "updated_at": "2026-06-05T09:00:00.000Z"
    }
  ],
  "count": 1,
  "summary": "1 category"
}

List chats

List a property's chats, newest first, with each chat's messages and transcript.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Fromfrom_timedate and time
Only chats from this moment on.
Toto_timedate and time
Only chats up to this moment. Defaults to now.
Dates apply todate_fieldtext
Whether From and To are about when chats started or when they last changed.One of: created (When it started (default)), updated (When it last changed). Default: created.
How manylimitnumber
How many chats to return, newest first (1 to 100).From 1 to 100. Default: 25.
Skipoffsetnumber
How many chats to skip, for the next page: use the step's next_offset.At least 0. Default: 0.

Outputs

chatslist
The chats, newest first
countnumber
How many are returned
has_moretrue/false
Whether there are more after these
next_offsetnumber
The Skip value that reads the next page; 0 when there is none
summarytext
One line saying what was found or done
totalnumber
How many there are in all
Example output
{
  "chats": [
    {
      "created_on": "2026-06-28T14:03:04.646Z",
      "id": "70fe3290-99ad-11e9-a30a-51567162179f",
      "message_count": 3,
      "messages": [
        {
          "attachments": [],
          "sender_id": "",
          "sender_name": "Customer Support",
          "sender_type": "system",
          "text": "Hi! How can we help?",
          "time": "2026-06-28T14:03:04.646Z",
          "type": "msg"
        },
        {
          "attachments": [],
          "sender_id": "",
          "sender_name": "",
          "sender_type": "visitor",
          "text": "Where is my order?",
          "time": "2026-06-28T14:03:20.176Z",
          "type": "msg"
        },
        {
          "attachments": [
            {
              "mime_type": "image/png",
              "name": "receipt.png",
              "size": 3797,
              "url": "https://tawkto.link/files/receipt.png"
            }
          ],
          "sender_id": "666668688fe587223fdf8685",
          "sender_name": "Eugene",
          "sender_type": "agent",
          "text": "It ships today. Here is the receipt.",
          "time": "2026-06-28T14:04:02.780Z",
          "type": "msg"
        }
      ],
      "property_id": "58ca8453b8a7e060cd3b1ecb",
      "status": "closed",
      "tags": [
        "billing"
      ],
      "transcript": "Customer Support: Hi! How can we help?\nMartins: Where is my order?\nEugene: It ships today. Here is the receipt.",
      "updated_on": "2026-06-28T14:09:12.120Z",
      "visitor_email": "hello@example.com",
      "visitor_name": "Martins"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "summary": "1 chat",
  "total": 1
}

List contact attributes

List the custom attributes a property's contacts (people or organizations) have.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Contactsrecord_typetext
People or organizations.One of: person (People), organization (Organizations). Default: person.

Outputs

attributeslist
The custom attributes
countnumber
How many are returned
summarytext
One line saying what was found or done
Example output
{
  "attributes": [
    {
      "data_type": "text",
      "full_path": "person.attributes.plan",
      "key": "plan",
      "label": "Plan",
      "object": "person"
    }
  ],
  "count": 1,
  "summary": "1 custom attribute"
}

List knowledge base sites

List the property's knowledge base sites, one per language.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.

Outputs

countnumber
How many are returned
siteslist
The sites
summarytext
One line saying what was found or done
Example output
{
  "count": 1,
  "sites": [
    {
      "enabled": true,
      "id": "primary",
      "language": "en",
      "primary": true,
      "title": "Help Center"
    }
  ],
  "summary": "1 site"
}

List members

List the agents and admins of a property.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.

Outputs

countnumber
How many are returned
memberslist
The property's members
summarytext
One line saying what was found or done
Example output
{
  "count": 1,
  "members": [
    {
      "email": "eugene@example.com",
      "id": "666668688fe587223fdf8685",
      "name": "Eugene",
      "role": "admin"
    }
  ],
  "summary": "1 member"
}

List properties

List the properties (websites and pages with the chat widget) your account belongs to, with their ids.

Inputs

None.

Outputs

countnumber
How many are returned
propertieslist
The properties
summarytext
One line saying what was found or done
Example output
{
  "count": 1,
  "properties": [
    {
      "id": "58ca8453b8a7e060cd3b1ecb",
      "name": "Bobs Burgers"
    }
  ],
  "summary": "1 property"
}

List tickets

List a property's tickets, newest first, with subject, status, requester and assignee.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Fromfrom_timedate and time
Only tickets from this moment on.
Toto_timedate and time
Only tickets up to this moment. Defaults to now.
Dates apply todate_fieldtext
Whether From and To are about when tickets started or when they last changed.One of: created (When it started (default)), updated (When it last changed). Default: created.
How manylimitnumber
How many tickets to return, newest first (1 to 100).From 1 to 100. Default: 25.
Skipoffsetnumber
How many tickets to skip, for the next page: use the step's next_offset.At least 0. Default: 0.

Outputs

countnumber
How many are returned
has_moretrue/false
Whether there are more after these
next_offsetnumber
The Skip value that reads the next page; 0 when there is none
summarytext
One line saying what was found or done
ticketslist
The tickets, newest first
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "summary": "1 ticket",
  "tickets": [
    {
      "assignee_name": "Eugene",
      "created_on": "2026-06-28T14:07:13.512Z",
      "human_id": 3,
      "id": "02598050-99ae-11e9-8887-97564881b95b",
      "message": "The parcel arrived damaged.",
      "property_id": "58ca8453b8a7e060cd3b1ecb",
      "requester_email": "martins@example.com",
      "requester_name": "Martins",
      "status": "open",
      "subject": "Refund for order 1042",
      "tags": [
        "refund"
      ],
      "updated_on": "2026-06-28T15:30:00.000Z"
    }
  ],
  "total": 1
}

List webhooks

List the webhooks set up on a property: where each posts and for which events.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.

Outputs

countnumber
How many are returned
summarytext
One line saying what was found or done
webhookslist
The webhooks
Example output
{
  "count": 1,
  "summary": "1 webhook",
  "webhooks": [
    {
      "enabled": true,
      "events": [
        "chat:start",
        "chat:end",
        "chat:transcript_created",
        "ticket:create"
      ],
      "id": "6672a1f0c3e5a8b1d2e4f601",
      "name": "Lodol",
      "url": "https://api.lodol.ai/webhooks/tawk_to/abc"
    }
  ]
}

Update article

Change a knowledge base article's title, text, subtitle, status, visibility or category; the rest stays as it is.

Inputs

Propertyproperty_idtextRequired
The website or page with the chat widget. Pick one, or give its id; a tawk.to dashboard link works too.
Article IDarticle_idtextRequired
The article's id, from 'Find articles' or 'Create article'.
Knowledge base sitesite_idtext
The site (one per language). Leave empty for the main site.
Titletitletext
A new title.
Texttexttext
New text, replacing the whole article. Separate paragraphs with a blank line, or give HTML (starting with <).
Subtitlesubtitletext
A new subtitle.
Statusstatustext
Publish, archive or move it back to draft.One of: draft, published, archived.
Visibilityvisibilitytext
Make it public or private.One of: public, private.
Categorycategory_idtext
Move it to this category.

Outputs

articleobject
The article
summarytext
One line saying what was found or done
Example output
{
  "article": {
    "author": "666668688fe587223fdf8685",
    "blocks": [
      {
        "content": {
          "heading": "h2",
          "text": "<p>Before you start</p>"
        },
        "type": "header"
      },
      {
        "content": {
          "text": "<p>Copy the widget code from <b>Administration</b>.</p>"
        },
        "type": "paragraph"
      }
    ],
    "category_ids": [
      "6672b1c0c3e5a8b1d2e4f710"
    ],
    "created_at": "2026-06-05T10:00:00.000Z",
    "downvotes": 1,
    "id": "6672b2a0c3e5a8b1d2e4f777",
    "site_id": "primary",
    "slug": "install-the-chat-widget",
    "status": "draft",
    "subtitle": "Add tawk.to to your site in five minutes",
    "text": "Before you start\n\nCopy the widget code from Administration.",
    "title": "Install the chat widget",
    "updated_at": "2026-06-06T09:30:00.000Z",
    "upvotes": 4,
    "visibility": "public"
  },
  "summary": "Updated the article Install the chat widget"
}

On this page