# Theymes

- [Product docs](https://docs.theymes.com/product/overview.md): Guides for using Theymes as a support team — coming here soon. Developer integration docs are available now.
- [Developers](https://docs.theymes.com/developers/index.md): Integrate Theymes into your game or website with the SDK, player metadata, widget, API, and automation.
- [Player Metadata](https://docs.theymes.com/developers/player-metadata/player-metadata.md): Theymes allows you to send metadata about the players to provide better support. With player metadata you can:
- [Player Verification](https://docs.theymes.com/developers/player-metadata/player-verification.md): We recommend that you setup Player Verification for your game from the start. This way you can block unverified players from contacting support right away, without having to wor...
- [Player Verification Guide](https://docs.theymes.com/developers/player-metadata/player-verification-guide.md): This guide will walk you through the process of setting up player verification for your game. We assume that you don't yet have an existing private key to sign your metadata JWT...
- [About Theymes SDK](https://docs.theymes.com/developers/sdk/about.md): Theymes SDK allows you to integrate Theymes into your game or web page. It allows you to gather feedback from your players, provide in-game support, and more.
- [About Unity SDK](https://docs.theymes.com/developers/sdk/unity/about.md): Theymes Unity SDK is a plugin for Unity that allows you to integrate Theymes into your iOS, Android, WebGL, Windows, macOS, and Linux games. It allows you to gather feedback fro...
- [Installing the SDK](https://docs.theymes.com/developers/sdk/unity/installing.md): Installing the Theymes Unity SDK is a straightforward process. You can either install the SDK from Git or from a tarball.
- [Configuring the SDK](https://docs.theymes.com/developers/sdk/unity/configuring.md): There are many options to customize the SDK to your needs. Theymes provides flexible way of configuring the SDK either by passing a TheymesConfig object to functions or by setti...
- [Notifications](https://docs.theymes.com/developers/sdk/unity/notifications.md): There are three kind of notications that Theymes SDK supports:
- [Push notifications](https://docs.theymes.com/developers/sdk/unity/push-notifications.md): To understand different notifications capabilities of Theymes SDK, please check the Notifications page. This page details how to setup push notifications for iOS and Android in...
- [Privacy and young players](https://docs.theymes.com/developers/sdk/unity/privacy-and-young-players.md): Theymes SDK doesn't collect any personal data from the player by default. However it is possible for the game to send data that is considered personal data to Theymes as form of...
- [API Reference](https://docs.theymes.com/developers/sdk/unity/api.md): All the Theymes SDK methods are static and can be called using the TheymesSdk class. The TheymesSdk class is located in the Theymes namespace.
- [About iOS SDK](https://docs.theymes.com/developers/sdk/ios/about.md): Theymes has a native iOS SDK for Swift and Objective-C. It lets you add in-app help center, open specific resources (e.g. articles or collectors), set player metadata, and use i...
- [Installing the SDK](https://docs.theymes.com/developers/sdk/ios/installing.md): Add the Theymes SDK to your iOS project with CocoaPods. Choose the SDK version from the Theymes iOS SDK releases page.
- [Configuring the SDK](https://docs.theymes.com/developers/sdk/ios/configuring.md): There are many options to customize the SDK to your needs. You can either pass a config dictionary to methods like openSupport(config:), or set configuration via the Theymes cla...
- [Notifications](https://docs.theymes.com/developers/sdk/ios/notifications.md): Theymes SDK supports three kinds of notifications:
- [Push notifications](https://docs.theymes.com/developers/sdk/ios/push-notifications.md): For an overview of notification types, see Notifications. This page describes how to set up push notifications on iOS.
- [Privacy and young players](https://docs.theymes.com/developers/sdk/ios/privacy-and-young-players.md): Theymes SDK doesn't collect any personal data from the player by default. However your app can send data that is considered personal (e.g. custom metadata or collector data) to...
- [API Reference](https://docs.theymes.com/developers/sdk/ios/api.md): All SDK methods are static and are called on the Theymes class.
- [About Android SDK](https://docs.theymes.com/developers/sdk/android/about.md): Theymes has a native Android SDK for Java and Kotlin.
- [About Web SDK](https://docs.theymes.com/developers/sdk/web/about.md): Theymes has a native Web SDK for Javascript. You can use the Web SDK in your game or as a widget on your web page.
- [Installing the SDK](https://docs.theymes.com/developers/sdk/web/installing.md): You can install the SDK from npm or using a <script> tag:
- [Configuring the SDK](https://docs.theymes.com/developers/sdk/web/configuring.md): There are many options to customize the SDK to your needs. You can either pass a config object to methods like openSupport(), or set configuration via the SDK methods (e.g. setL...
- [Using the SDK](https://docs.theymes.com/developers/sdk/web/using.md): If you install the SDK with <script> tag, the SDK is in window.theymes namespace, e.g. theymes.initialize.
- [Web Widget](https://docs.theymes.com/developers/sdk/web/web-widget.md): If you install the widget with <script> tag, the SDK is in window.theymes namespace, e.g. theymes.initialize.
- [Content Security Policy (CSP)](https://docs.theymes.com/developers/sdk/web/content-security-policy.md): If you use Content Security Policy in your game or on your web page, this guide helps you to make sure Theymes SDK works with your policy.
- [API Reference](https://docs.theymes.com/developers/sdk/web/api.md): JavaScript SDK methods for initializing Theymes, opening support, and configuring the player.
- [Automation](https://docs.theymes.com/developers/automation/overview.md): Automation lets you run repeatable support processes automatically in Theymes. You can react to events, collect information from tickets and players, call external services, upd...
- [Triggers](https://docs.theymes.com/developers/automation/triggers.md): A trigger decides when an automation starts. Trigger automations run automatically. Workflows use a manual workflow trigger that agents can run from a ticket.
- [Actions and Switches](https://docs.theymes.com/developers/automation/actions-and-switches.md): Actions are the steps an automation runs after its trigger. Each action can use static values or Liquid variables from the trigger and previous actions.
- [Liquid Variables](https://docs.theymes.com/developers/automation/liquid-variables.md): Automations use Liquid variables to insert values from triggers and previous actions into text fields. You can use variables in places such as messages, private notes, Slack mes...
- [Workflows](https://docs.theymes.com/developers/automation/workflows.md): Workflows are automations that agents run manually from a ticket. Use workflows for repeatable processes that still need an agent's judgment, such as escalations, refunds, inves...
- [Runs and Errors](https://docs.theymes.com/developers/automation/runs-and-errors.md): Every time an automation starts, Theymes creates a run. Runs help you understand what happened, which actions executed, what values were produced, and why an automation failed.
- [Theymes API](https://docs.theymes.com/developers/api.md): The Theymes API allows you to interact with Theymes platform programmatically. You can use it to access and manage resources.
- [Get tickets](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-tickets.md): Get tickets
- [Post tickets](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/post-tickets.md): Create a new ticket. To include attachments, call POST /attachments to obtain upload URLs, upload the files, and pass the returned attachment IDs in the `attachments` array.
- [Post attachments](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/post-attachments.md): Generate a pre-signed upload URL for a ticket attachment. Upload the file with an HTTP PUT request to the returned URL, then pass the attachment ID in the POST /tickets request.
- [Get attachments](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-attachments.md): Redirect to a short-lived signed URL for downloading a previously uploaded ticket attachment.
- [Post tickets actions](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/post-tickets-actions.md): Perform actions on a ticket such as managing metadata, sending messages, assigning, changing status, and closing
- [Get tickets events](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-tickets-events.md): Get selected ticket events, including message attachments as downloadable attachment IDs.
- [Get tickets breadcrumbs](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-tickets-breadcrumbs.md): Get SDK breadcrumbs captured for a ticket.
- [Get games](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-games.md): Get games for the company associated with the API key
- [Get tags](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-tags.md): Get tags for the company associated with the API key
- [Get fields](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/get-fields.md): Get fields for the company associated with the API key
- [Post playerschedule deletion](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/post-playerschedule-deletion.md): Schedule deletion of a player's data. The player will be scheduled to be deleted in 24 hours. The scheduled deletion can be cancelled from the Theymes application if necessary.
- [Delete player](https://docs.theymes.com/api-reference/authenticated-endpoints-api-key/delete-player.md): Immediately and permanently delete a player's data. Unlike schedule-deletion, there is no 24-hour delay and the deletion cannot be cancelled. This endpoint is only available to companies that have been explicitly allowlisted; contact Theymes to request access.
- [Get supportsessionsredirect](https://docs.theymes.com/api-reference/public-support-links-no-authentication/get-supportsessionsredirect.md): Create a web support session from metadata passed in the query string and redirect the player to the public web support site with the session code attached (`sid`). Requires no authentication; the game is identified by its game environment `token`. Extra `player.*`, `tags`, and `fields.*` query para…
- [Post supportsessions](https://docs.theymes.com/api-reference/public-support-links-no-authentication/post-supportsessions.md): Create a web support session from metadata passed in the request body and return the session code together with the full public web support URL that has the session code attached (`sid`). Requires no authentication; the game is identified by its game environment `token`.

## OpenAPI Specs

- [openapi](https://api.theymes.com/openapi)

## Optional

- [Theymes](https://theymes.com)
- [Support app](https://app.theymes.com)