Manage chats, tickets, and properties in tawk.to live chat via the tawk.to REST API v1.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

tawk-to

Manage chats, tickets, and properties in tawk.to live chat via the tawk.to REST API v1.

What it does

Operation	Description
`get_agent`	Retrieve the current authenticated agent's profile details
`list_properties`	List all properties (websites/widgets) on the account
`list_tickets`	List support tickets for a given property
`create_ticket`	Create a new support ticket on a property

Authentication

tawk.to uses HTTP Basic Authentication for its REST API.

Log in to your tawk.to dashboard.
Go to Account > REST API tab.
Enable REST API access (approval may take up to 24 hours).
Copy your API Key once it appears.

The API key is used as the HTTP Basic Auth username; the password is empty. The tool handles encoding automatically — just supply the raw key.

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

Inputs

Input	Required	Description
`apiKey`	Yes	Your tawk.to REST API key
`operation`	Yes	One of: `get_agent`, `list_properties`, `list_tickets`, `create_ticket`
`propertyId`	For ticket ops	tawk.to property (site) ID — visible in the dashboard URL or returned by `list_properties`
`subject`	For `create_ticket`	Ticket subject line
`message`	For `create_ticket`	Ticket body / first message
`requesterName`	No	Requester display name (for `create_ticket`)
`requesterEmail`	No	Requester email address (for `create_ticket`)

Outputs

Output	Description
`result`	JSON response body from the tawk.to API
`status`	HTTP status code as a string (e.g. `"200"`)

Examples

Get current agent info

operation: get_agent
apiKey: your-api-key-here

List all properties

operation: list_properties
apiKey: your-api-key-here

List tickets for a property

operation: list_tickets
apiKey: your-api-key-here
propertyId: 5b4b2c34df9d2s74f9344abc

Create a support ticket

operation: create_ticket
apiKey: your-api-key-here
propertyId: 5b4b2c34df9d2s74f9344abc
subject: Login issue
message: I am unable to log in to my account since yesterday.
requesterName: Alice Smith
requesterEmail: [email protected]

Notes

REST API access must be explicitly enabled by tawk.to (account approval required).
list_tickets accepts only propertyId — additional filters (date range, status) are not yet supported in this tool version.
The result output contains the raw JSON string from tawk.to; use an expression step or the AI assistant to parse fields from it.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: get_agent, list_properties, list_tickets, create_ticket
`propertyId`	string	no	—	tawk.to property (site) ID. Required for list_tickets and create_ticket. Find it in the tawk.to dashboard URL or REST API response from list_properties.
`subject`	string	no	—	Ticket subject. Required for create_ticket.
`message`	string	no	—	First message / body for create_ticket.
`requesterName`	string	no	—	Requester display name for create_ticket.
`requesterEmail`	string	no	—	Requester email address for create_ticket.