[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8},"actionData","errors","root",{"_155":156,"_157":158,"_159":160,"_20":21,"_161":-7,"_162":163,"_164":165,"_166":167,"_168":-5,"_169":31,"_170":31,"_171":-5,"_172":-5,"_173":174,"_175":176,"_51":177,"_178":179},"docs-content",{"_9":10,"_10":11,"_12":13,"_14":15,"_16":17,"_18":19},"type","article",{"_57":137,"_118":136,"_138":-5,"_139":140,"_141":133,"_142":-5,"_143":144,"_145":146,"_22":147,"_24":25,"_135":148,"_120":149,"_150":-5,"_151":152,"_153":154},"breadcrumbData",{"_128":129,"_130":131},"prevArticle",{"_22":123,"_57":124,"_118":125,"_120":126},"nextArticle",{"_22":116,"_57":117,"_118":119,"_120":121},"context",{"_20":21},"portal",{"_22":23,"_24":25,"_26":27,"_28":20,"_29":27,"_30":31,"_32":33,"_34":35,"_36":37,"_38":39,"_40":41,"_42":43,"_44":41,"_45":46,"_47":48,"_49":50,"_51":-7,"_52":53,"_54":55,"_56":-7},"id","9ae77332-80b3-4302-b8a5-f0a74c773dbf","tenantId","unthread-unthread-e4pm8","isExternal",true,"mode","isEnabled","requireAuthentication",false,"identityPlatformTenantId","e-unthread-3berp","loginMethods",[109,110,111],"settings",{"_94":95,"_96":97,"_98":97,"_99":100,"_101":102,"_103":104,"_105":-7,"_106":107,"_108":27},"tenant",{"_85":86,"_87":88},"customDomain","docs.unthread.io","defaultDomain","unthread.help.unthread.io","canonicalDomain","projectIds",[84],"customLinks",[64,65,66,67],"featuredCollections",[61,62,63],"collections","ticketTypeSections",[],"homepageMetadata",{"_57":58,"_59":60},"statusBanner","title","Welcome to Unthread's Helpdesk","description","Browse through docs, ask the AI for help, or manage your own support tickets.","ac886cfd-cbf6-4cb0-b3b0-b66d3ca36752","f3a97e0f-079d-4251-9569-077912cb5dff","6b0ca0aa-e17d-4485-af21-e8bf8610f86e",{"_57":81,"_69":82,"_71":83,"_72":-7},{"_57":77,"_69":78,"_71":79,"_72":80},{"_57":74,"_69":75,"_71":-5,"_72":76},{"_57":68,"_69":70,"_71":-5,"_72":73},"Book a Demo","link","https://unthread.io/demo","icon","buttonStyle","primary","Dashboard","https://app.unthread.io","light","API Docs","https://docs.unthread.io/docs/api-docs/api-reference","server","default","Contact us","mailto:support@unthread.io","mail","e9ce1893-1a81-419e-abc6-8898f4532b56","name","Unthread","allowedPriorities",{"_89":31,"_90":27,"_91":27,"_92":27,"_93":27},"1","3","5","7","9","logoUrl","https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fportal-logos%2Ficon-transparent.png?alt=media","lightLogoUrl","","darkLogoUrl","primaryColor","#f2453e","darkThemeAccentColor","#f2443f","fontFamily","dmSans","homepageBannerUrl","homepageBannerTextColor","black","allowDirectTicketCreation",{"_9":115,"_113":27},{"_9":114,"_113":31},{"_9":112,"_113":31},"sso","enabled","emailPassword","magicLink","73d94f1f-ae9c-46bd-8333-8fdab2daf7bd","Accounts","slug","accounts","collectionPath",[122],"global-workspace-settings","9417c561-404f-4ee3-84d8-27b689eb8169","Understanding Ticket Types, Tags, and Custom Fields in Unthread","understanding-ticket-types-tags-and-custom-fields-in-unthread",[127],"faqs","currentItem",{"_22":136,"_85":137,"_9":10},"breadcrumbs",[132],{"_22":133,"_85":134,"_118":127,"_9":135},"f10863c7-8fe8-42f4-9112-ea23db1ca8e4","FAQs","collection","unthread-outbound-ip-addresses-for-firewall-allowlisting","Unthread outbound IP addresses for firewall allowlisting","url","content","Traffic from Unthread may come from any of the following outbound IP addresses. If your endpoint restricts inbound traffic by source IP, allowlist all of them:\n\n- 34.135.70.193\n- 34.134.133.208\n- 34.28.221.26\n- 34.69.152.47\n- 52.34.139.153\n- 54.69.127.183\n- 44.247.133.183\n- 52.26.211.56","collectionId","projectId","createdAt","2026-09-03T18:56:10.198Z","updatedAt","2026-09-09T14:00:08.110Z","f85205ba-e4b9-4b6f-ace7-ab8ff555e0ea",{"_22":133,"_85":134},[],"hostedUrl","userGroups",[],"channels",[],"cspNonce","ef8c9770a8df7e3913ef4cc9d08b1be8b70a20be7c121e5a8e0da33a66b0ba0c","firebaseConfig",{"_1616":1617,"_1618":41,"_142":1619},"session",{"_1611":1612,"_1613":27},"inAppChat","mixpanelToken","cc23843c498db1553f595eae3fae57d7","sentryDsn","https://cd638f7e7e056e6e02d1d91f09ba2fa9@o563911.ingest.us.sentry.io/4510302612946944","environment","prd","theme","isMac","isEmbed","embedConfig","userProfile","projects",[1603],"articles",[1178,1179,1180,1181,1182,1183,1184,1185,1186,1187,1188,1189,1190,1191,1192,1193,1194,1195,1196,1197,1198,1199,1200,1201,1202,1203,1204,1205,1206,1207,1208,1209,1210,1211,1212,1213,1214,1215,1216,1217,1218,1219,1220,1221,1222,1223,1224,1225,1226,1227,1228,1229,1230,1231,1232,1233,1234,1235,1236,1237,1238,1239,1240,1241,1242,1243,1244,1245,1246,1247,1248,1249,1250,1251,1252,1253,1254,1255,1256,1257,1258,1259,1260,1261,1262],[180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195],"uncategorizedArticles",[],{"_85":1161,"_118":1162,"_59":-5,"_71":1163,"_198":-5,"_142":-5,"_143":1164,"_145":1165,"_22":61,"_24":25,"_201":202,"_175":1166,"_204":1167},{"_85":1105,"_118":1106,"_59":-5,"_71":36,"_198":-5,"_142":-5,"_143":1107,"_145":1108,"_22":62,"_24":25,"_201":1109,"_175":1110,"_204":1111},{"_85":1010,"_118":1011,"_59":-5,"_71":898,"_198":-5,"_142":-5,"_143":1012,"_145":1013,"_22":1014,"_24":25,"_201":385,"_175":1015,"_204":1016},{"_85":973,"_118":974,"_59":-5,"_71":975,"_198":-5,"_142":-5,"_143":976,"_145":977,"_22":978,"_24":25,"_201":483,"_175":979,"_204":980},{"_85":896,"_118":897,"_59":-5,"_71":898,"_198":-5,"_142":-5,"_143":899,"_145":900,"_22":901,"_24":25,"_201":902,"_175":903,"_204":904},{"_85":858,"_118":859,"_59":-5,"_71":860,"_198":-5,"_142":-5,"_143":861,"_145":862,"_22":863,"_24":25,"_201":483,"_175":864,"_204":865},{"_85":600,"_118":601,"_59":-5,"_71":602,"_198":-5,"_142":-5,"_143":603,"_145":604,"_22":63,"_24":25,"_201":249,"_175":605,"_204":606},{"_85":531,"_118":532,"_59":-5,"_71":533,"_198":-5,"_142":-5,"_143":534,"_145":535,"_22":536,"_24":25,"_201":537,"_175":538,"_204":539},{"_85":516,"_118":517,"_59":-5,"_71":83,"_198":-5,"_142":-5,"_143":518,"_145":519,"_22":520,"_24":25,"_201":202,"_175":521,"_204":522},{"_85":477,"_118":478,"_59":-5,"_71":479,"_198":-5,"_142":-5,"_143":480,"_145":481,"_22":482,"_24":25,"_201":483,"_175":484,"_204":485},{"_85":379,"_118":380,"_59":-5,"_71":381,"_198":-5,"_142":-5,"_143":382,"_145":383,"_22":384,"_24":25,"_201":385,"_175":386,"_204":387},{"_85":77,"_118":352,"_59":-5,"_71":79,"_198":-5,"_142":-5,"_143":353,"_145":354,"_22":355,"_24":25,"_201":356,"_175":357,"_204":358},{"_85":134,"_118":127,"_59":-5,"_71":246,"_198":-5,"_142":-5,"_143":247,"_145":248,"_22":133,"_24":25,"_201":249,"_175":250,"_204":251},{"_85":233,"_118":122,"_59":234,"_71":-5,"_198":-5,"_142":-5,"_143":235,"_145":235,"_22":236,"_24":25,"_201":202,"_175":237,"_204":238},{"_85":216,"_118":217,"_59":-5,"_71":-5,"_198":-5,"_142":-5,"_143":218,"_145":219,"_22":220,"_24":25,"_201":202,"_175":221,"_204":222},{"_85":196,"_118":197,"_59":-5,"_71":-5,"_198":-5,"_142":-5,"_143":199,"_145":199,"_22":200,"_24":25,"_201":202,"_175":203,"_204":205},"Personal Settings and Notifications","personal-settings-and-notifications","parentId","2026-04-29T13:36:55.700Z","53c910af-e807-4764-990f-1da7d256356b","articleCount",1,[206],"subCollections",[],{"_57":207,"_118":208,"_138":-5,"_139":209,"_141":200,"_142":-5,"_143":210,"_145":211,"_22":212,"_24":25,"_120":213,"_150":-5,"_151":214,"_153":215},"Personal Notification Settings","personal-notification-settings","### How to change personal notification settings\n\nOnce logged in as an Unthread Agent, Owner, or Admin you can change your notification settings by clicking your user profile in the top right of any page in the Unthread UI.\n\n![Unthread-04-29-2026_09_42_AM.png](/api/knowledge-base/images/686ab8f6-200b-40f4-8931-981b3b80e178)\n\nSelect Notification settings to adjust your preferences.\n\n![image.png](/api/knowledge-base/images/82dfa2b8-048b-4548-84a6-14294a222d1b)\n\n## Stop following a conversation (Unthread dashboard)\n\nIf you’re getting Unthread notifications for a conversation you no longer want to follow, open the conversation in the Unthread web dashboard and remove yourself as a follower from the right-hand side of the conversation page.","2026-04-29T13:42:34.207Z","2026-05-15T18:45:59.245Z","aec5c3c2-9891-49bc-bb14-3c31dbcf6da5",[],[],[],"Knowledge Base","knowledge-base","2026-04-27T22:16:15.140Z","2026-05-01T15:47:22.779Z","73642454-3483-4fd5-9712-56b2e6eee071",[223],[],{"_57":224,"_118":225,"_138":-5,"_139":226,"_141":220,"_142":-5,"_143":227,"_145":228,"_22":229,"_24":25,"_120":230,"_150":-5,"_151":231,"_153":232},"Knowledge Base Setup","knowledge-base-setup","Connect your documentation to provide better answers for AI-generated responses or for suggesting responses to your support reps. Let’s walk through how to set it up!\n\n![knowledgebase-list.png](/api/knowledge-base/images/956286a3-1cef-4b85-a573-47ca06c9179d)\n\n## Connecting to Your Existing Documentation\n\nUnthread can sync documentation from any web-based documentation system automatically by crawling pages and adding them to your knowledge base. To do this, head over to the Dashboard then click “Knowledge” on the left then select “Sources” finally “Add Source”\n\n### Adding Public Documentation Sites\n\n![kb-add-public.png](/api/knowledge-base/images/3ec432fe-8947-45c9-8ed0-5c9a7b640f94)\n\nTo sync in a public-facing website of documentation, you can enter the base URL of the page, and Unthread AI will automatically crawl and ingest all of the subpages within it. Advanced options include the ability to add certain root URLs to an allowlist or blocklist.\n\n⚠️Some large public documentation does not need to be added as a source and scraped because all AI models already have awareness of the information from it being publicly available across the web. For examples, URLs from Apple's public-facing website of documentation can't, and do not need to be added and scraped as a webpage source in your workspace.\n\n### Adding Internal Documentation\n\nFor internal wikis, you’ll want to use our native integrations with your platform of choice to provide us access to the correct pages to sync. In each case, you can choose the root folder or URL and have Unthread AI scrape all subpages. Supported native integrations:\n\n- Google Drive\n- Notion\n- Confluence\n- Wiki.js\n- Coda\n- SharePoint\n- Freshservice\n- GitHub\n- Airtable\n\n### Workspace-level vs. project-level sources (and duplicates)\n\nYou can keep a workspace-level (global) knowledge base while also allowing each project/team to create their own Google Drive / Notion sync job.\n\n- **Global knowledge**: It can be helpful to keep global knowledge, but consider using it more sparingly.\n- **Project-level knowledge**: Teams can connect and manage their own sources for their project.\n\nGoogle IAM accounts\n\nYou should be able to reuse the same Google IAM account across projects. When connecting a Google Drive source, teams can provide the same IAM credentials when they connect.\n\n### Using Unthread AI “built-in” knowledge (public documentation)\n\nBy default, Unthread’s bot prompt is configured to only use knowledge sources that are connected in your Unthread **Knowledge** section. This is to prevent the bot from answering outside the scope of your company.\n\nIf you want Unthread AI to also use its built-in knowledge about tools (for example, answering basic questions about Google Drive using publicly available documentation), ask the Unthread team to enable this via a backend setting.\n\nAlternatively, you can connect your own documentation sources in Unthread and keep the bot restricted to those sources.\n\n### Freshservice Knowledge Base: “Delete stale articles”\n\nWhen syncing a **Freshservice Knowledge Base** source, the **Delete stale articles** option only affects the copies of articles stored in **Unthread**.\n\n- If enabled, Unthread will delete the corresponding article record in Unthread when the article has been deleted in Freshservice.\n- This does **not** delete anything in Freshservice.\n\nMost teams enable this option to avoid stale articles remaining searchable in Unthread.\n\n### Adding One-off Articles\n\nIf you’d like to add individual articles or Q&As to your knowledge base, click to the “Text” option when adding to your knowledge base. From here, you can write a custom title and content, while optionally also including a relevant link if a customer asks this question.\n\n### Keeping Things Up to Date\n\nAfter uploading, you will see a list of documentation sets and the date that the documentation was last synced. If you make a change and need it to go live immediately, you can also click the “Re-run sync” to immediately refresh the list.\n\n## Testing Responses\n\nAfter you’ve connected your documentation, you can see how the AI will generate responses for you. From the Knowledge Base tab, click the “Test response” button. It will present you with a text box to enter a prompt, and hitting submit will generate a response as well as surface the articles used to generate the answer.\n\n![image.png](/api/knowledge-base/images/d3d7454d-cf9e-440b-94d2-01627bd65b48)\n\n## Learning From Previous Conversations\n\nAs you manage support tickets through Unthread, you’ll likely start answering the same question and you’ll want to reference that in future answers.\n\n### Generating Articles\n\nAs you close out a conversation (marking it as resolved), the system automatically detect if the answer is not yet captured in your knowledge base. If not, we’ll generate a draft article using AI that you can edit before storing to your knowledge base for future use!\n\n![generate-article.gif](/api/knowledge-base/images/1b12be66-eb5a-4c7c-8397-e7bafb1f7548)\n\n### Reviewing Suggestions\n\nYou can review the recommended articles to create by navigating to “Knowledge” > “Suggestions”. This will show you a history of resolved conversations not yet captured in your knowledge base. As you create articles, they’ll automatically be removed from the list.\n\n- If a user is an **organization Admin** but can’t see anything in a specific project’s **Knowledge → Suggestions** tab, make sure they are also added as a **member of that project**.\n- In the project, go to **Setup → Members** and add the user.\n\n## Analytics\n\nTo view the history of responses generated and feedback on any of the documents used in your replies, you can see the AI analytics section under the [AI responses](https://docs.unthread.io/docs/analytics/ai-analytics#ai-generated-response-history) section.\n\n## Enabling AI responses\n\nAI responses can be enabled across Slack, email, in-app chat, and Microsoft Teams. We have an article specifically on how to leverage the Auto-Responder for this:\n\n📖 [*AI-Generated Responses*](https://docs.unthread.io/docs/unthread-ai/ai-generated-responses)","2023-12-03T18:55:51.389Z","2026-09-03T13:36:10.549Z","bc59ca2e-64e8-482f-9f9a-6e162db8fed2",[],[],[],"Global Workspace Settings","The settings that apply to your Unthread workspace at the highest level. This includes administrative account management functionality along with other settings.","2026-04-23T15:32:33.531Z","a2145e34-f8e1-4ecb-b1ff-b580331d1d4f",[239],[],{"_57":117,"_118":119,"_138":-5,"_139":240,"_141":236,"_142":-5,"_143":241,"_145":242,"_22":116,"_24":25,"_120":243,"_150":-5,"_151":244,"_153":245},"### What are Accounts?\n\n**Accounts** are used to define **external customer accounts** when Unthread is being used with customers external to your organization. You can add **Accounts from the Workspace Settings --> Accounts**.\n\n### What settings are defined at the Account level?\n\n- **Account Name:** Name of the external customer organization that will be visible on tickets.\n- **Account Tags:** Optional Tags you can add to an Account for filtering, reporting, SLAs, and automations.\n- **Associated email domain(s)** of the Account organization: The email domain matches new tickets to the correct customer Account.\n- **Associated Slack Channels** (#account name-Unthread): All shared slack channels between your organization and the customer account that Unthread has been added to.\n- **HubSpot Integration & Synced CRM contacts** if applicable: Our [HubSpot integration ](https://docs.unthread.io/docs/integrations/hubspot)enables syncing of the HubSpot Account configuration to Unthread Accounts and pushes tracked Slack conversations into HubSpot in the Account activity feed.\n- **SLA Override Configuration:** Use this option to create an SLA specific to a customer Account rather than using the Project or Channel level SLA settings.\n- **Primary and Secondary Support Representatives** defined for this Account within your organization: You can utilize the primary and secondary support representatives designated in the Account settings in your SLAs to route tickets to them first, defer to the secondary representative when the primary one is unavailable, and in automations should you wish to do thinks like send message alerts to these representatives about Account ticket activity.\n- **Account Admins** designated within the customer Account: This provisions external users with permission to view all tickets in this account.\n\n![image.png](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2Fe05a794e-53ab-462d-bb55-f5c297c3a2c3.png?alt=media)\n\n### Accounts and the External Customer Portal\n\nIf you enable your Unthread hosted [External Customer Portal ](https://docs.unthread.io/docs/in-app-support/customer-portal-overview)and require authentication for your external customers to access the portal, one of the authentication options is to \"**Restrict Login to Account Domains**.\" When enabled, only individuals using an email domain associated with one or more of your **Accounts** will be able to access the External Customer Portal via authentication.\n\n![image.png](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2F8dec1250-bd8b-4ee1-81d2-464013752e69.png?alt=media)\n\n### How to Update or Delete an Account\n\n\\*Note that only Unthread Administrators and Owners within your organization can Add, Update, and Delete Accounts\n\n- Click the **Account name** to open the Account details modal\n- Update any **Account fields** an click **save to update**\n- Use the **trashcan icon** on the bottom right of the Account details modal to **delete** the Account","2026-04-23T15:59:46.459Z","2026-05-19T13:35:59.659Z",[],[],[],"help-circle","2025-09-24T21:44:22.729Z","2025-10-08T20:27:22.787Z",11,[252,253,254,255,256,257,258,259,260,261,262],[],{"_57":343,"_118":344,"_138":-5,"_139":345,"_141":133,"_142":-5,"_143":346,"_145":347,"_22":348,"_24":25,"_120":349,"_150":-5,"_151":350,"_153":351},{"_57":334,"_118":335,"_138":-5,"_139":336,"_141":133,"_142":-5,"_143":337,"_145":338,"_22":339,"_24":25,"_120":340,"_150":-5,"_151":341,"_153":342},{"_57":325,"_118":326,"_138":-5,"_139":327,"_141":133,"_142":-5,"_143":328,"_145":329,"_22":330,"_24":25,"_120":331,"_150":-5,"_151":332,"_153":333},{"_57":317,"_118":-5,"_138":-5,"_139":318,"_141":133,"_142":-5,"_143":319,"_145":320,"_22":321,"_24":25,"_120":322,"_150":-5,"_151":323,"_153":324},{"_57":308,"_118":309,"_138":-5,"_139":310,"_141":133,"_142":-5,"_143":311,"_145":312,"_22":313,"_24":25,"_120":314,"_150":-5,"_151":315,"_153":316},{"_57":299,"_118":300,"_138":-5,"_139":301,"_141":133,"_142":-5,"_143":302,"_145":303,"_22":304,"_24":25,"_120":305,"_150":-5,"_151":306,"_153":307},{"_57":290,"_118":291,"_138":-5,"_139":292,"_141":133,"_142":-5,"_143":293,"_145":294,"_22":295,"_24":25,"_120":296,"_150":-5,"_151":297,"_153":298},{"_57":281,"_118":282,"_138":-5,"_139":283,"_141":133,"_142":-5,"_143":284,"_145":285,"_22":286,"_24":25,"_120":287,"_150":-5,"_151":288,"_153":289},{"_57":272,"_118":273,"_138":-5,"_139":274,"_141":133,"_142":-5,"_143":275,"_145":276,"_22":277,"_24":25,"_120":278,"_150":-5,"_151":279,"_153":280},{"_57":124,"_118":125,"_138":-5,"_139":266,"_141":133,"_142":-5,"_143":267,"_145":268,"_22":123,"_24":25,"_120":269,"_150":-5,"_151":270,"_153":271},{"_57":137,"_118":136,"_138":-5,"_139":140,"_141":133,"_142":-5,"_143":144,"_145":146,"_22":147,"_24":25,"_120":263,"_150":-5,"_151":264,"_153":265},[],[],[],"This article provides clarity on the usage of Ticket Types, Tags, and Custom Fields in Unthread, as well as the meaning of \"Submitted By\" in the Inbox view.\n\n### Ticket Types vs. Tags\n\n- [**Ticket Types**](https://docs.unthread.io/docs/conversational-ticketing/ticket-types): These are used for categorizing conversations and allow for custom attributes to be associated with each type. This involves manual selection via dropdowns or other inputs.\n- **Tags**: These are simpler categorizations that can be applied to conversations and customers. Tags can be set manually or automatically by AI.\n- **Recommendation**: Use Ticket Types if custom attributes are needed; otherwise, Tags are a streamlined option for categorization.\n\n### \"Submitted By\" Definition\n\n- The \"Submitted By\" field in the Inbox view refers to the initiator of the conversation.\n- This can be used to track individual initiators and analyze the topics they frequently address by filtering analytics by submitter and viewing the breakdown by Tags.\n\n### Custom Fields vs. Tags in the Customer View\n\n- **Custom Fields**: These are custom profile attributes that can be set up and viewed when managing a conversation.\n- **Customer Tags**: These are standard categorizations for accounts, useful for custom filtering and reporting.\n\nBy understanding these features, you can effectively categorize and analyze conversations and customer interactions in Unthread.","2024-12-17T15:34:18.585Z","2026-05-13T21:41:17.024Z",[],[],[],"Tracking Time Spent by Assignee on Tickets","tracking-time-spent-by-assignee-on-tickets","To determine how much time each engineer spends on a specific ticket, you can utilize the \"waiting on agent time\" metric. This metric provides insights into the duration an agent is actively engaged with a ticket. By analyzing this data, you can effectively monitor and manage the time allocation of engineers on individual tickets.","2025-03-06T20:55:24.411Z","2025-10-30T18:39:41.781Z","43f7a70b-208a-40de-99a8-649e1a216420",[],[],[],"Snowflake integration: service user authentication and RBAC scoping","snowflake-integration-service-user-authentication-and-rbac-scoping","# Snowflake integration: service user authentication and RBAC scoping\n\nUnthread connects to Snowflake using a dedicated Snowflake service user (for example, `UNTHREAD_SVC`).\n\n## Authentication\n\nThe Snowflake connection uses **a username and key** for authentication.\n\n## Permission scoping (read-only vs. read-write)\n\nYou can enforce the integration’s access using **standard Snowflake RBAC restrictions**.\n\n- You can set **read-only** or **read-write** permissions.\n- You can scope permissions on a **per-table** or **per-schema** basis.\n\n### Recommended least-privilege approach\n\nTo minimize access, grant the service user **write permissions only to the specific tables you want Unthread to write to**.\n\nWith this approach, the service user would not be able to read or write anything else.","2026-05-15T17:53:06.198Z","2026-05-18T22:13:01.276Z","7196c0e0-233e-4698-9862-a6f3195eb47e",[],[],[],"Slack Permissions Explained","slack-permissions-explained","Below you will find a list of all the permissions we request and how we use them.\n\n## App Mentions\n\n`app_mentions:read`\n\n- **Description**: View messages that directly mention @Unthread in conversations that the app is in\n- **Request Reason**: We can optionally add you as the follower or assignee of a ticket if you are mentioned in a comment.\n\n## Channels\n\n`channels:history`\n\n- **Description**: View messages and other content in public channels that Unthread has been added to\n- **Request Reason**: We automatically track new tickets in channels that you add our bot to. New messages from customers in the channel can automatically be tracked as tickets.\n\n`channels:join`\n\n- **Description**: Join public channels in a workspace\n- **Request Reason**: We allow you to automatically add our bot to channel from the web UI. This also allows you to automatically track certain channels like customer Slack channels.\n\n`channels:manage`\n\n- **Description**: Manage public channels that Unthread has been added to and create new ones\n- **Request Reason**: This allows you to create new channels for triaging threads internally. You can create a temporary channel for discussing a ticket.\n\n`channels:read`\n\n- **Description**: View basic information about public channels in a workspace\n- **Request Reason**: This allows you to view a list of available channels to connect or use as a triage channel.\n\n`channels:write.invites`\n\n- **Description**: Invite members to public channels\n- **Request Reason**: This allows you to automatically join new triage channels for tickets that you’re a part of.\n\n`channels:write.topic`\n\n- **Description**: Set the description of public channels\n- **Request Reason**: This allows you to pin a ticket history view to the top of a channel. More information on the ticket history view here ↗.\n\n## Chat\n\n`chat:write`\n\n- **Description**: Send messages as @Unthread\n- **Request Reason**: This allows you to send replies and mass broadcasts to channels from the Unthread web app.\n\n`chat:write.customize`\n\n- **Description**: Send messages as @Unthread with a customized username and avatar\n- **Request Reason**: This allows you to send broadcasts as a separate support rep or as a support team.\n\n## Commands\n\n`commands`\n\n- **Description**: Add shortcuts and/or slash commands that people can use\n- **Request Reason**: This allows easy shortcuts to Unthread actions to modify tickets. You can open a modal to edit ticket details by using our “Manage conversation” shortcut on any message.\n\n## Emoji\n\n`emoji:read`\n\n- **Description**: View custom emoji in a workspace\n- **Request Reason**: This allows you to use custom emojis to trigger actions like closing tickets.\n\n## Files\n\n`files:read`\n\n- **Description**: View files shared in channels and conversations that Unthread has been added to\n- **Request Reason**: This allows you to view attachments in Slack channels from the Unthread web dashboard.\n\n`files:write`\n\n- **Description**: Upload, edit, and delete files as Unthread\n- **Request Reason**: This allows you to upload files from the Unthread web dashboard. You can upload photos and other documents from the web UI and have them visible in the Slack thread for a ticket.\n\n## Groups (Private Channels)\n\n`groups:history`\n\n- **Description**: View messages and other content in private channels that Unthread has been added to\n- **Request Reason**: This allows you to use private channels as triage channels. If you add the Unthread bot a private channel, we can publish messages there and track conversation history.\n\n`groups:read`\n\n- **Description**: View basic information about private channels that Unthread has been added to\n- **Request Reason**: This allows you to browse the list of available channels that the Unthread bot is in.\n\n`groups:write`\n\n- **Description**: Manage private channels that Unthread has been added to and create new ones\n- **Request Reason**: This allows you to create a new private message from the Unthread web dashboard.\n\n`groups:write.invites`\n\n- **Description**: Invite members to private channels\n- **Request Reason**: This allows you to automatically create new channels with relevant members of a ticket.\n\n`groups:write.topic`\n\n- **Description**: Set the description of private channels\n- **Request Reason**: This allows you to pin a ticket history view to the top of a channel. More information here ↗.\n\n## Instant Messages (Direct Messages)\n\n`im:history`\n\n- **Description**: View messages and other content in direct messages that Unthread has been added to\n- **Request Reason**: This allows you to directly message the Unthread bot to create new tickets. More information on bot DMs [here](https://docs.unthread.io/docs/conversational-ticketing/bot-for-slack-private-tickets).\n\n`im:read`\n\n- **Description**: View basic information about direct messages that Unthread has been added to\n- **Request Reason**: This allows you to directly message the Unthread bot to create new tickets. More information on bot DMs [here](https://help.unthread.unthread.io/articles/d955cd9d-eeed-4c43-b746-86f402977760).\n\n`im:write`\n\n- **Description**: Start direct messages with people\n- **Request Reason**: This allows you to directly message the Unthread bot to create new tickets. More information on bot DMs [here](https://help.unthread.unthread.io/articles/d955cd9d-eeed-4c43-b746-86f402977760).\n\n## Multi-Party Instant Messages (Group DMs)\n\n`mpim:history`\n\n- **Description**: View messages and other content in group direct messages that Unthread has been added to\n- **Request Reason**: This allows you to track group messages as tickets if the Unthread is included.\n\n`mpim:read`\n\n- **Description**: View basic information about group direct messages that Unthread has been added to\n- **Request Reason**: This allows you to track group messages as tickets if the Unthread is included.\n\n## Pins\n\n`pins:write`\n\n- **Description**: Add and remove pinned messages and files\n- **Request Reason**: This allows you to pin a ticket history view to the top of a channel so members can view the status of previous tickets they’ve submitted. More information on that [here](https://help.unthread.unthread.io/articles/7ac9e92c-e4aa-459f-a668-16a53c91e545).\n\n## Reactions\n\n`reactions:read`\n\n- **Description**: View emoji reactions and their associated content in channels and conversations that Unthread has been added to\n- **Request Reason**: This allows you to see message reactions from the web dashboard. You can see both standard and custom emojis for a conversation thread.\n\n`reactions:write`\n\n- **Description**: Add and edit emoji reactions\n- **Request Reason**: This allows you to add emoji reactions to messages from the web dashboard. You can add both standard and custom emojis to a conversation thread.\n\n## Team\n\n`team:read`\n\n- **Description**: View the name, email domain, and icon for workspaces Unthread is connected to\n- **Request Reason**: This allows you to see team members in your workspace and set them as agents and assignees.\n\n## User Groups\n\n`usergroups:read`\n\n- **Description**: View user groups in a workspace\n- **Request Reason**: This allows you to set groups as assignees of tickets (for example, assigning to an on-call rotation).\n\n`usergroups:write`\n\n- **Description**: Create and manage user groups\n- **Request Reason**: This allows you to update a user group for an on-call rotation. More information on using user groups can be found here ↗.\n\n## Users\n\n`users.profile:read`\n\n- **Description**: View profile details about people in a workspace\n- **Request Reason**: This allows you to have the user’s most recent name and photo up to date. When selecting an assignee, we’ll show you the name and photo of the user being selected.\n\n`users:read`\n\n- **Description**: View people in a workspace\n- **Request Reason**: This allows you to see team members in your workspace and set them as agents and assignees.\n\n`users:read.email`\n\n- **Description**: View email addresses of people in a workspace\n- **Request Reason**: This allows you to have the latest email address available for users if using our email support ticketing functionality.","2025-07-21T16:04:45.201Z","2026-05-13T21:38:06.011Z","b7f40037-b033-4d6b-8d6e-17c2731b82ff",[],[],[],"Integrating Customer Portals with Unthread for Ticket Management","integrating-customer-portals-with-unthread-for-ticket-management","### Overview\n\nThis article provides guidance on integrating customer portals with Unthread for managing support tickets. It covers how to ensure that tickets are correctly attributed to customers and how to maintain privacy and security.\n\n### Setting Up a [Customer Portal](https://docs.unthread.io/docs/in-app-support/customer-portal-overview)\n\n- **Single Portal Configuration:** It is recommended to create a single customer portal configuration. This setup allows users to view only their tickets, ensuring privacy and security.\n- **Ticket Attribution:** Tickets submitted through the customer portal are attributed to the customer profile based on the authenticated user's email. This ensures that analytics and data are correctly associated with the respective customer.\n\n### Ticket Management\n\n- **Channel Posting:** Tickets from the customer portal are not posted to a customer-facing Slack channel. Instead, they are managed internally, allowing for private handling of customer issues.\n- **Agent Access:** Agents create and manage tickets through the Unthread dashboard, not through the customer portal.\n\n### Security and Authentication\n\n- **User Authentication:** The portal supports user authentication to ensure that tickets are separated by customer. This is crucial for maintaining privacy and ensuring that users only see their own tickets.\n\n### Conclusion\n\nBy following these guidelines, you can effectively integrate a customer portal with Unthread, ensuring that tickets are managed securely and attributed correctly to each customer. This setup also allows for efficient internal handling of support tickets while maintaining customer privacy.","2024-12-03T15:32:40.523Z","2026-05-13T21:28:44.996Z","0570d9fa-3f63-4ee1-aa63-79a7b7b8d40d",[],[],[],"How to Generate a Google Gemini API Key (Service Account Key)","how-to-generate-a-google-gemini-api-key-service-account-key","These steps will create a **Google Cloud service account** with the right permissions and give you a JSON key file to share securely.\n\n### 1. Sign in to Google Cloud Console\n\n1. Go to: \n\n2. Make sure you’re in the **correct Google Cloud project** that is tied to your Google Workspace / Gemini instance.\n\n### 2. Enable the Vertex AI API (if not already enabled)\n\n1. In the top search bar, type **\"Vertex AI API\"**.\n\n2. Click **Enable**.\n\n - If it says “API enabled,” you can skip this step.\n\n### 3. Create a Service Account\n\n1. In the left menu, go to **IAM & Admin > Service Accounts**.\n\n2. Click **+ CREATE SERVICE ACCOUNT**.\n\n3. Fill in:\n\n - **Service account name:** `gemini-api-access` (or similar)\n\n - **Description:** \"Access for Gemini API calls\"\n\n4. Click **Create and Continue**.\n\n### 4. Grant the Required Role\n\n1. Under **Grant this service account access**, click **+ Select a role**.\n\n2. In the search box, type:\n\n ```\n Vertex AI User\n \n ```\n\n and select it.\n\n3. (Optional but safer) If you want to scope it down further, you can create a **custom role** that only has:\n\n ```\n aiplatform.endpoints.predict\n \n ```\n\n but \"Vertex AI User\" is the standard.\n\n4. Click **Continue**, then **Done**.\n\n### 5. Create a JSON Key\n\n1. In the **Service Accounts list**, find your new account.\n\n2. Click the three dots (**⋮**) on the right > **Manage keys**.\n\n3. Under **Keys**, click **Add key > Create new key**.\n\n4. Choose **JSON** and click **Create**.\n\n - This downloads a file ending in `.json`.\n\n - **This file is your API key.**\n\n### 6. Send the Key Securely\n\n- **Do not email the file as an attachment.**\n\n- Instead:\n\n - Upload it to a secure company file-share (e.g., Google Drive with restricted access).\n\n - Or use a secure password manager’s sharing feature.\n\n- Notify us when it’s shared.","2025-09-24T21:44:11.121Z","2025-09-24T21:44:29.518Z","bd81e821-86fe-4a1a-86e0-bc476ccf415e",[],[],[],"How to create a Checklist within a Ticket Type","## Using Ticket Type Custom Fields to create a Checklist for Agents\n\nSome ticket types, like new hire onboarding for example, require a checklist of actions to be completed before the new hire onboarding ticket type can be closed. You can use the custom field properties to create a checklist that will be visible to agent only in the details sidebar of the conversation.\n\n \\\n![image.png](/api/knowledge-base/images/b98c2bd0-0181-4a6f-8618-b0e81ff1867d)\n\n## Creating the Checklist within the Ticket Type\n\n- Create a new custom field with the type of \"Label\" to specify the name of the checklist\n- Add subsequent custom checkbox fields with the checklist items required for the ticket type\n- Make sure the checklist isn't a required field or visible to the submitter by de-selecting the question mark and eyeball icons on the custom field\n\n![image.png](/api/knowledge-base/images/18aee36e-3cbe-48df-b5d6-8c934139a73a)","2026-06-02T13:06:55.883Z","2026-06-02T13:14:58.408Z","2d5cdf8b-daad-4e47-a4f0-0fcb7362fa3a",[],[],[],"How to Change the Unthread Application Name in Slack","how-to-change-the-unthread-application-name-in-slack","Want Unthread to show up with a different name in Slack? You can rename the Unthread bot directly from your Slack app configuration.\n\nThis will update the bot name that members see when Unthread sends messages in your Slack workspace.\n\n## **Renaming the Bot**\n\nTo change the Unthread bot name in Slack:\n\n1. Open Slack’s **Installed Apps** page for your workspace.\n\n > ℹ️ You can also go directly to: `https://app.slack.com/apps-manage//integrations/installed`\n\n2. Search for **Unthread**.\n\n3. Click into the Unthread app, then select **App Details**.\n\n4. Go to the **Configuration** tab.\n\n5. Scroll down to the section labeled **Bot User**.\n\n6. Click **Edit**.\n\n7. Enter the new bot name, then save your changes.\n\nThat’s it! The Unthread bot will now appear with the updated name in Slack.\n\n## **Can’t Edit the Bot User?**\n\nIf you don’t see the option to edit the bot user, you may not have permission to manage apps in Slack. Ask a Slack Workspace Owner, Admin, or app manager to make the change for you.","2026-04-29T14:32:00.374Z","2026-04-29T15:03:42.188Z","1700d928-c665-481e-8676-cc4a9dce25fd",[],[],[],"How to Change the Logo and Bot Name for a Specific Team","how-to-change-the-logo-and-bot-name-for-a-specific-team","To change the logo and bot name for a specific team (project), follow these steps:\n\n1. Navigate to **Settings**\n2. Select **Projects**\n3. Click on the specific team you want to modify, such as the HR or IT team.\n4. Look for the option labeled **Support Name & Logo**.\n5. Update the logo and bot name as desired.\n\n## When will the updated name appear in Slack?\n\nAfter updating the bot/app name for a project, the new name will appear in Slack the next time the bot posts a message to the channel.\n\nThis process allows you to customize the logo and bot name for individual teams without affecting others. If you encounter any issues or have further questions, feel free to reach out to support for assistance.","2025-01-05T21:14:51.040Z","2026-05-15T18:49:24.089Z","8122880c-bb82-47d3-9c4d-bd951d3d0470",[],[],[],"Bot & Private Tickets - Unthread","bot-private-tickets-unthread","Unthread’s bot for Slack is the easiest way to intake customer requests, [generate AI responses](https://docs.unthread.io/docs/unthread-ai/ai-generated-responses), [assign to team members](https://docs.unthread.io/docs/conversational-ticketing/slas), and manage tickets end-to-end. As a customer, you will already see the Unthread app for Slack in your workspace as a way to view your [inbox](https://docs.unthread.io/docs/managing-your-inbox/managing-your-slack-inbox) and get notifications about conversations. The Unthread bot for Slack messaging tab is a great way to let customers easily create new support tickets for your team.\n\n## The Benefits of Bot Ticket Intake\n\n- All conversations are by default private between the user and ticket assignees\n- Users no longer need to remember the various Slack channels for support – all requests can funnel through the bot\n- You can set up custom SLAs and auto-response settings for the bot vs. other support channels\n\n![Example of a DM request](https://mintlify.s3.us-west-1.amazonaws.com/unthread/images/dm-promotion-request.png)\n\n## Users Viewing Ticket Submissions\n\nFrom the Unthread app homepage in Slack, users can view their history of requests, and easily jump back into the conversation. ![Example of viewing tickets](https://mintlify.s3.us-west-1.amazonaws.com/unthread/images/my-requests-view.png)\n\n## Privacy & Sending Tickets to the Right Agents\n\nWhen the user submits a question, they’ll be prompted to select the correct [Ticket Type](https://docs.unthread.io/docs/conversational-ticketing/ticket-types) for their request. As an example, if they select a “Laptop Replacement”, you can configure the request to be sent directly to the IT team. Separately, if they request “Time Off”, you can be sure this request is relayed directly to the HR team. Unthread will automatically handle privacy limitations so that ticket visibility is limited to only the correct team fielding the request. ![](https://mintlify.s3.us-west-1.amazonaws.com/unthread/images/ticket-thread.png)\n\n## Using Unthread AI\n\nAs discussed above, users can select the right ticket for their request, but you can also leverage Unthread AI to make this process even easier:\n\n- Unthread AI can generate a helpdesk answer and deflect tickets before they reach a human\n- If the request is unclear, the bot can ask clarifying questions\n- Once a ticket needs to be created, the bot can auto-detect the ticket type, and the user can confirm\n- If additional fields are requested for that ticket, the bot can auto-populate these fields based on the conversation\n\n## Enabling the Bot for Slack\n\nHead over to the “Settings” > “Slack”, and look for the “Bot DM” section to enable. You can also select a default Customer that will be linked for all new tickets created from DMs.\n\n## White-Labeling the Bot\n\nWe also support launching your own Slackbot with your own brand and image. To configure this, navigate to the “Settings” menu in the left sidebar, then select “Settings” under the corresponding project. Next to the “Bot Configuration” section, you can configure your own brand and image.","2024-10-16T15:22:08.108Z","2026-05-11T19:52:56.943Z","1ca215bb-4e44-4c1e-abc8-a1a9a20b0eab",[],[],[],"api-docs","2025-09-09T20:27:46.142Z","2025-10-08T20:19:42.138Z","eceee293-2334-444e-8851-be6efa5dcd01",2,[359,360],[],{"_57":370,"_118":371,"_138":-5,"_139":372,"_141":355,"_142":-5,"_143":373,"_145":374,"_22":375,"_24":25,"_120":376,"_150":-5,"_151":377,"_153":378},{"_57":361,"_118":362,"_138":-5,"_139":363,"_141":355,"_142":-5,"_143":364,"_145":365,"_22":366,"_24":25,"_120":367,"_150":-5,"_151":368,"_153":369},"Webhooks","webhooks","Unthread provides webhooks which allow you to receive HTTP POST requests when data is created or updated.\n\n## Configuration\n\nCreate an HTTP endpoint capable of receiving and responding to POST requests containing JSON payloads. The endpoint must be publicly accessible and must use HTTPS. The endpoint should respond with a 200 status code within 30 seconds of receiving a request.\n\n### URL Verification\n\nWhen the endpoint URL is given to Unthread, Unthread will emit a “url_verification” event. Your endpoint must respond to this request with a 200 status code within 3 seconds.\n\n### Security\n\nTo ensure security, your endpoint should validate that event payloads are signed with the signing secret available from the Unthread dashboard. This ensures that the events are coming from Unthread and not from a malicious source. Create an HMAC-SHA256 hash of the request body using the singing secret as the key and compare it to the signature included in the “X-Unthread-Signature” HTTP header. If the two values match, then the signature is considered valid.\n\n### Payload\n\nEvents will have the following structure:\n\n```plaintext\n{\n \"event\": \"conversation_created\", // The event type.\n \"eventId\": \"49bac55d-5445-4e70-ad72-c87e2e8adb3f\", // Unique ID for the event.\n \"eventTimestamp\": 1678732685142, // When the event took place, in milliseconds.\n \"webhookTimestamp\": 1678732685382, // When the event was sent, in milliseconds.\n \"data\": {\n // The event data, depends on the event type.\n \"id\": \"b72c8bcd-0387-4a6d-92b3-14016c3c53e5\"\n }\n}\n```\n\nThe following `event` types are supported:\n\n- `'conversation_created'`\n- `'conversation_updated'`\n- `'conversation_deleted'`\n- `'message_created'`\n\n### Retries\n\nIf the endpoint returns a status code other than 200 or it times out, the event will be retried up to 4 more times at increasing intervals. An “X-Unthread-Attempt-Number” HTTP header starting at 1 is included in every request to identify when a retry is occurring. If an endpoint fails consecutively more than 100 times or returns a 410 status code, it will be disabled automatically.\n\nIt is possible, though unlikely, that an event will be resent after succeeding. Your endpoint should be prepared to handle this case gracefully using the “eventId” property.\n\n## Examples\n\n```plaintext\nconst { createHmac } = require('crypto');\n\n// Example of how to get the rawBody property if using express:\n/***\napp.use(\n express.json({\n verify: (req, res, buf) => {\n req.rawBody = buf.toString();\n }\n })\n);\n***/\n\n// Replace the value here with one obtained from your Unthread dashboard.\nconst SIGNING_SECRET = 'your_signing_secret_here';\n\nfunction verifySignature(req) {\n // It's recommended to use raw request body content in the hash since JSON parsing might change it.\n const rawBody = req.rawBody;\n\tconst hmac = createHmac('sha256', SIGNING_SECRET).update(rawBody).digest('hex');\n\n\treturn return mac === req.get('x-unthread-signature');\n}\n\nfunction webhookHandler(req, res) {\n\tif (!verifySignature(req)) {\n\t\tres.sendStatus(403);\n\t\treturn;\n }\n\n\tconst { event, data } = req.body;\n\n if (event === 'url_verification') {\n // Respond within 3 seconds.\n res.status(200);\n return;\n }\n\n // Handle other event types here.\n\n // Default to returning 200.\n\tres.sendStatus(200);\n}\n```\n\n```plaintext\nimport hashlib\n\n# Replace the value here with one obtained from your Unthread dashboard.\nSIGNING_SECRET = 'your_signing_secret_here'\n\ndef verify_signature(request):\n hmac = hashlib.sha256(SIGNING_SECRET.encode('utf-8'), request.get_data(), digestmod=hashlib.sha256).hexdigest()\n\n return hmac == request.headers.get('x-unthread-signature')\n\n@app.route('/webhook', methods=['POST'])\ndef webhook():\n if not verify_signature(request):\n return 'Invalid signature', 403\n\n body = request.get_json()\n event = body.get('event')\n\n if event == 'url_verification':\n # Respond within 3 seconds.\n return 'OK', 200\n\n\t\t# Handle other event types here.\n\n # Default to returning 200.\n return 'OK', 200\n```\n\n## Zapier\n\nA webhook trigger is available as part of Unthread’s integration with [Zapier](https://docs.unthread.io/docs/integrations/zapier). You will need to create a connection to Unthread using your Unthread API key and you will also need to provide your webhook signing secret. The Zapier integration will automatically configure your webhook within Unthread. The integration will automatically validate webhook event signatures and ignore any events with invalid signatures.\n\n## Make (Integromat)\n\nA webhook trigger is available as part of Unthread’s integration with Make. You will need to create a connection to Unthread using your Unthread API key and you will also need to provide your webhook signing secret. The Zapier integration will automatically configure your webhook within Unthread. The integration will NOT automatically validate webhook event signatures however it is possible to configure your scenario to validate the signature. Add a “Transform to JSON” step and pass in the “payload” property from the Unthread webhook step. Then add a “Webhook Response” step with the following expression in the “Status” field: `if(sha256(; \"hex\"; ) = ; 200; 403)`. This will return a 403 status code if the signature is invalid.","2023-12-03T18:55:48.334Z","2026-05-13T21:04:51.582Z","2281de72-fe64-4357-a7ca-b2c078b33a8f",[],[],[],"API Reference","api-reference","Everything in Unthread is driven by our powerful API. You can set up your own Service Account to get an API key with specific permissions.\n\n## Create a Service Account to Generate an API Key\n\nIn order to call the API, you will first need to create a service account. Service Accounts are given permissions just like users, and they can be scoped to a [Project](https://docs.unthread.io/docs/setting-up-your-account/projects-permissions), or be tenant-wide.\n\nTo generate a **Project-scoped API key**, go to \"Setup\" > \"Service Accounts\"\n\nTo generate a **tenant-wide API key** (if you're a platform admin or owner), you can go to \"Workspace Settings\" > \"Service Accounts\".\n\nOptionally, you can add a helpful description and a date of expiration of the service account. There are no limits on the number of service accounts that you create.\n\nAfter creating the new service account, you will see a window displaying the service account’s API key. Copy this key and put it somewhere safe and secret. **Once you close the window you will not be able to view the key again.**\n\n## Calling the API\n\nThe URL for calls to the API will have the following form, with $ being replaced by the endpoint you are trying to call:\n\n```plaintext\nhttps://api.unthread.io/api/${endpoint}\n```\n\nIn order to authenticate, you must send an HTTP header with the key “X-Api-Key” and the value set to the service account key created in the previous section. All request and response bodies will be in JSON.\n\n## \n\n## API Conventions\n\nThe Unthread API follows RESTful conventions when possible, with most operations performed via `GET`, `POST`, `PATCH`, and `DELETE` requests. Request and response bodies are encoded as JSON.\n\n### List Endpoints\n\nAll list endpoints follow the same conventions. Requests are made in the following format:\n\n```plaintext\ninterface Where {\n field: WhereField;\n operator: '==' | '!=' | '>' | '<' | 'in' | 'notIn' | 'contains' | 'notContains' | 'like';\n value: string | number | string[];\n}\n\ninterface ListRequest {\n select?: Array;\n order?: Array;\n where?: Array>;\n limit?: number;\n descending?: boolean;\n cursor?: string;\n}\n```\n\nAccepted values for SelectField, OrderByField and WhereField depend on the object. Responses are made in the following format:\n\n```plaintext\ninterface ListResponse {\n data: Array;\n totalCount: number;\n cursors: {\n hasNext: boolean;\n hasPrevious: boolean;\n next?: string;\n previous?: string;\n };\n}\n```\n\nResponses are paginated by providing a cursor to the next or previous page. The limit per page is 100. An example list request is provided below:\n\n```plaintext\n// Request\n// POST /conversations/list\n{\n \"select\": [\n\t\t\"id\",\n\t\t\"title\",\n\t\t\"initialMessage.ts\",\n\t\t\"initialMessage.text\",\n\t\t\"tags.id\",\n\t\t\"tags.name\"\n\t],\n \"order\": [\"createdAt\", \"id\"],\n \"where\": [\n {\n \"field\": \"customerId\",\n \"operator\": \"==\",\n \"value\": \"9YQjOSTFXeOPF8xNURFd\"\n }\n ],\n \"descending\": true,\n \"limit\": 1,\n \"cursor\": \"W3RydWUsWyIwNTU4MTc5Zi1kYTJkLTQxZjItOTZlYy1iZGY2YzkzZGQ1MjIiXV0=\"\n}\n\n// Response\n{\n \"data\": [\n {\n \"id\": \"0476bfd0-0c3f-4dfb-b462-d75a4a6908e1\",\n\t\t \"title\": \"A bug report\",\n\t\t \"initialMessage\": {\n \"ts\": \"1675183719.124879\",\n \"text\": \"Help, I found a bug\"\n } ,\n\t\t \"tags\": [\n {\n \"id\": \"32561c55-0f01-47af-aa55-1a3d638f41e8\",\n \"name\": \"Bug\"\n }\n ]\n }\n ],\n \"totalCount\": 688,\n \"cursors\": {\n \"hasNext\": true,\n \"hasPrevious\": true,\n \"next\": \"W3RydWUsWyIwNDUzYmFiNi1iNDY3LTQ0MGMtYmMzZi1mNWEyODQ5YzlkYWUiXV0=\",\n \"previous\": \"W2ZhbHNlLFsiMDI4ZDg3NzMtY2I5Ni00MDQzLTlmYjYtMGZhOWUzYmFmY2MzIl1d\"\n }\n}\n```\n\n### Create and Update Endpoints\n\nCreate and update endpoints can specify a `select` query param that takes a comma-separated list of fields to return in the response. Example below:\n\n```plaintext\n// Request\n// PATCH /conversations/0476bfd0-0c3f-4dfb-b462-d75a4a6908e1?select=id,title,initialMessage.ts,initialMessage.text,tags.id,tags.name\n{\n \"status\": \"closed\"\n}\n\n// Response\n{\n \"id\": \"0476bfd0-0c3f-4dfb-b462-d75a4a6908e1\",\n \"title\": \"A bug report\",\n \"initialMessage\": {\n \"ts\": \"1675183719.124879\",\n \"text\": \"Help, I found a bug\"\n } ,\n \"tags\": [\n {\n \"id\": \"32561c55-0f01-47af-aa55-1a3d638f41e8\",\n \"name\": \"Bug\"\n }\n ]\n}\n```\n\n## \n\n## Objects\n\n### Conversation\n\n```plaintext\ninterface Conversation {\n id: string;\n status: \"open\" | \"in_progress\" | \"on_hold\" | \"closed\";\n subStatusId: string;\n customerId: string | null;\n channelId: string;\n wasManuallyCreated: boolean;\n friendlyId: number;\n createdAt: string;\n updatedAt: string;\n closedAt: string | null;\n statusUpdatedAt: string | null;\n responseTime: number | null;\n responseTimeWorking: number | null;\n resolutionTime: number | null;\n resolutionTimeWorking: number | null;\n title: string | null;\n priority: number | null;\n initialMessage: Message;\n assignedToUserId: User | null;\n tags: Array;\n customer: Customer | null;\n wakeUpAt: string | null;\n summary: string | null;\n snoozedAt: string | null;\n lockedAt: string | null;\n ticketTypeId: string | null;\n ticketTypeFields: Record;\n metadata?: Record;\n projectId: string;\n followers?: {\n userId?: string;\n groupId?: string;\n entityId: string;\n }[];\n collaborators?: {\n collaboratorTypeId: string;\n userId?: string;\n groupId?: string;\n entityId: string;\n }[];\n files?: {\n id: string;\n name: string;\n size: number;\n filetype: string;\n mimetype: string;\n }[];\n triageThreads?: {\n id: string;\n ts: string;\n channelId: string;\n createdAt?: Date;\n }[];\n}\n```\n\n### Message\n\n```plaintext\ninterface Message {\n ts: string;\n userId: string;\n userTeamId: string;\n botId: string;\n botName: string;\n text: string;\n subtype: string | null;\n conversationId: string;\n timestamp: string;\n threadTs: string | null;\n conversation: Conversation;\n user: User | null;\n metadata?: {\n eventType?:\n | \"autoresponder_replied\"\n | \"email_received\"\n | \"email_explanation_sent\"\n | \"widget_message_received\"\n | \"microsoft_teams_message_received\"\n | \"unthread_outbound\"\n | \"post_close_template_sent\"\n | \"customer_view_button\"\n | \"slack_bot_dm_received\";\n };\n}\n```\n\n### Customer (aka Channel)\n\n```plaintext\ninterface Customer {\n name: string;\n primarySupportAssigneeId: string | null;\n primarySupportAssigneeType: \"user\" | \"team\" | null;\n secondarySupportAssigneeId: string | null;\n secondarySupportAssigneeType: \"user\" | \"team\" | null;\n replyTimeoutMinutes: number | null;\n defaultTriageChannelId: string | null;\n disableAutomatedTicketing: boolean | null;\n botHandling: \"off\" | \"all\" | null;\n autoresponder: AutoresponderOptions | null;\n supportSteps: Array | null;\n slackTeamId: string | null;\n assignToTaggedUserEnabled: boolean | null;\n slackChannelId: string | null;\n createdAt: string;\n updatedAt: string;\n tags: Array;\n slackChannel: SlackChannel | null;\n projectId: string;\n}\n```\n\n### Tag\n\n```plaintext\ninterface Tag {\n id: string;\n name: string;\n description: string;\n autoTaggingEnabled: boolean;\n projectId: string;\n}\n```\n\n### User\n\n```plaintext\ninterface User {\n id: string;\n name: string;\n email: string;\n slackId: string;\n photo: string;\n customFields: CustomField[];\n}\n```\n\n### User Team\n\n```plaintext\ninterface UserTeam {\n id: string;\n name: string;\n slackId: string;\n}\n```\n\n### Slack Channel\n\n```plaintext\ninterface SlackChannel {\n id: string;\n name: string;\n isShared: boolean;\n isPrivate: boolean;\n}\n```\n\n### Simple Condition\n\n```plaintext\ninterface SimpleCondition {\n leftValue?: any;\n leftValueFrom?: string;\n operator: \"equals\" | \"notEquals\" | \"greaterThan\" | \"lessThan\" | \"greaterThanOrEquals\" | \"lessThanOrEquals\" | \"contains\" | \"notContains\" | \"in\" | \"notIn\";\n rightValue?: any;\n rightValueFrom?: string;\n}\n```\n\nFor a “simple condition”, the left and right values are compared using the operator. For example, if the operator is “equals”, the left and right values are compared for equality. For left and right values, either a value can be provided directly or a reference to a field in the “context”, through the `leftValueFrom` and `rightValueFrom` fields.\n\nThe “context” depends on the object and the operation. For example, for ticket type field conditions, the context has the following shape:\n\n```plaintext\n{\n \"conversation\": {\n \"ticketTypeFields\": {\n \"12345678-1234-1234-1234-123456789abc\": \"value-1\",\n \"42345678-1234-1234-1234-123456789abd\": \"value-2\"\n }\n }\n}\n```\n\nTherefore, a condition can be added on a ticket type field like this:\n\n```plaintext\n{\n \"leftValueFrom\": \"conversation.ticketTypeFields['12345678-1234-1234-1234-123456789abc']\",\n \"operator\": \"equals\",\n \"rightValue\": \"value-1\"\n}\n```\n\nThis will cause the field to be available for a given conversation if the ticket type has field `12345678-1234-1234-1234-123456789abc` set to `value-1`.\n\n### Ticket Type Field\n\n```plaintext\ninterface TicketTypeField {\n id: string;\n label: string;\n type: \"short-answer\" | \"long-answer\" | \"multi-select\" | \"single-select\" | \"checkbox\" | \"user-select\" | \"multi-user-select\";\n required: boolean;\n public: boolean;\n description: string;\n options?: string[];\n conditions?: {\n type: \"simple\";\n simple:\n | SimpleCondition\n | {\n and: SimpleCondition[];\n }\n | {\n or: SimpleCondition[];\n };\n };\n}\n```\n\nFor ticket type field conditions, the only context\n\n### Ticket Type\n\n```plaintext\ninterface TicketType {\n id: string;\n name: string;\n projectId: string;\n description: string;\n createdAt: string;\n updatedAt: string;\n fields: Array;\n}\n```\n\n### Autoresponder Options\n\n```plaintext\ninterface AutoresponderOptions {\n enabled: boolean;\n condition: \"always\" | \"outside-working-hours\";\n message: string;\n}\n```\n\n### Support Step\n\n```plaintext\ninterface SupportStep {\n type: \"assignment\" | \"escalation\" | \"reminder\" | \"triage\";\n assigneeId?: string;\n assigneeType?: \"user\" | \"team\";\n minutes: number;\n shouldCycleThroughTeamMembers?: boolean;\n maxCycles?: number;\n cycleMinutes?: number;\n}\n```\n\n### Outbound\n\n```plaintext\ninterface Outbound {\n id: string;\n status: \"scheduled\" | \"draft\" | \"sent\" | \"failed\";\n deliveryMethod: \"slack\";\n subject: string;\n // See Slack Block Kit documentation for details on the blocks field: https://api.slack.com/block-kit\n blocks: Array;\n recipients: {\n type: \"customer\";\n id: string;\n }[];\n sendAs: {\n // For type == \"support-rep\" the ID is the user ID to use as a default if there is no support rep for a given customer.\n type: \"user\" | \"support-rep\";\n id: string;\n };\n runAt: string;\n}\n```\n\n### Webhook Subscription\n\n```plaintext\ninterface WebhookSubscription {\n id: string;\n url: string;\n enabled: boolean;\n}\n```\n\n### Approval Request\n\n```plaintext\ninterface ApprovalRequest {\n status: \"approved\" | \"rejected\" | \"pending\";\n id: string;\n tenantId: string;\n assignedToGroupId?: string;\n assignedToUserId?: string;\n statusChangedAt?: Date;\n conversationId: string;\n title?: string;\n notes?: string;\n createdAt: Date;\n approverUser?: User;\n approverGroup?: UserTeam;\n}\n```\n\n### Collaborator Type\n\n```plaintext\ninterface CollaboratorType {\n id: string;\n name: string;\n key: string;\n description?: string;\n}\n```\n\n### Account\n\n```plaintext\ninterface Account {\n id: string;\n name: string;\n primarySupportAssigneeId: string | null;\n primarySupportAssigneeType: \"user\" | \"team\" | null;\n secondarySupportAssigneeId: string | null;\n secondarySupportAssigneeType: \"user\" | \"team\" | null;\n emailsAndDomains: string[];\n slackChannelIds: string[];\n slackTeamIds: string[];\n customFields: any[];\n supportSteps: any[];\n imageUrl: string | null;\n externalCrmMetadata: {\n id: string;\n } | null;\n createdAt: string;\n updatedAt: string;\n createdBy: string;\n updatedBy: string;\n slackChannels: Array;\n slackTeams: Array<{\n id: string;\n name: string;\n icon: string;\n }>;\n tags: Array;\n}\n```\n\n### User Group\n\n```plaintext\ninterface UserGroup {\n id: string;\n description?: string;\n isExternal: boolean;\n filters: Array;\n projectId: string | null;\n}\n```\n\n### Filter\n\n```plaintext\ninterface Filter {\n field: string;\n operator: 'contains' | 'notContains' | 'in' | 'notIn' | 'equals' | 'notEquals' | 'lessThan' | 'greaterThan' | 'isNull' | 'isNotNull' | 'stringContains' | 'stringNotContains'\n value: any;\n}\n```\n\n# Endpoints\n\n## Accounts\n\n**Create Account**\n\n```plaintext\nPOST /accounts\n```\n\nThis endpoint will create and return a new account.\n\nRequest schema:\n\n```plaintext\ninterface CreateAccountRequest {\n name: string;\n primarySupportAssigneeId?: string | null;\n primarySupportAssigneeType?: \"user\" | \"team\" | null;\n secondarySupportAssigneeId?: string | null;\n secondarySupportAssigneeType?: \"user\" | \"team\" | null;\n emailsAndDomains?: string[];\n slackChannelIds?: string[];\n slackTeamIds?: string[];\n customFields?: any[];\n supportSteps?: any[];\n imageUrl?: string | null;\n externalCrmMetadata?: {\n id: string;\n } | null;\n}\n```\n\n### Get Account by ID\n\n```plaintext\nGET /accounts/:accountId\n```\n\nThis endpoint will return the given account.\n\n### Update Account\n\n```plaintext\nPATCH /accounts/:accountId\n```\n\nThis endpoint will return the updated account. All fields from the create request schema can be updated.\n\n### Delete Account\n\n```plaintext\nDELETE /accounts/:accountId\n```\n\nThis endpoint will delete the given account.\n\n### List Accounts\n\n```plaintext\nPOST /accounts/list\n```\n\nThis endpoint will return a list of accounts following the standard list conventions. Supported fields for select, order, and where operations:\n\n- `id`\n- `name`\n- `imageUrl`\n- `primarySupportAssigneeId`\n- `primarySupportAssigneeType`\n- `secondarySupportAssigneeId`\n- `secondarySupportAssigneeType`\n- `primarySupportAssignee.id`\n- `primarySupportAssignee.name`\n- `secondarySupportAssignee.id`\n- `secondarySupportAssignee.name`\n- `emailsAndDomains`\n- `slackChannelIds`\n- `slackTeamIds`\n- `customFields`\n- `supportSteps`\n- `createdAt`\n- `updatedAt`\n- `createdBy`\n- `updatedBy`\n- `slackChannels.id`\n- `slackChannels.name`\n- `slackChannels.isPrivate`\n- `slackChannels.isShared`\n- `slackChannels.archivedAt`\n- `slackChannels.slackTeamId`\n- `slackTeams.id`\n- `slackTeams.name`\n- `slackTeams.icon`\n- `tags.id`\n- `tags.name`\n- `externalCrmMetadata`\n\n## \n\n## Approval Requests\n\n### **Create Approval Request for Conversation**\n\n```plaintext\nPOST /conversations/:conversationId/approval-requests\n```\n\nThis endpoint will return the newly created approval request. Fields that can be set on create are: `title`, `assignedToUserId` and `assignedToGroupId`.\n\n### **Get Approval Requests for Conversation**\n\n```plaintext\nGET /conversations/:conversationId/approval-requests\n```\n\nThis endpoint will return a list of approval requests for the given conversation.\n\n## \n\n## Automations\n\n**Create Automation**\n\n```plaintext\nPOST / automations;\n```\n\nThis endpoint creates a new automation.\n\n**Request Body**\n\nThe request body should be a JSON object with the following structure:\n\n```plaintext\n{\n name: string;\n description?: string | null;\n status?: 'draft' | 'active' | 'inactive';\n trigger: AutomationTrigger;\n steps: AutomationStep[];\n conditions?: Conditions | null;\n}\n```\n\n- `name` (required): The name of the automation.\n- `description` (optional): A description of the automation.\n- `status` (optional): The status of the automation. Defaults to ‘draft’ if not provided.\n- `trigger` (required): The trigger configuration for the automation.\n- `steps` (required): An array of steps that define the automation’s actions.\n- `conditions` (optional): Conditions that determine when the automation should run.\n\n### AutomationTrigger\n\nThe `trigger` field should be an object with a `type` property and a `data` property. The structure depends on the trigger type:\n\n```plaintext\n{\n type: \"event\" | \"manual\" | \"webhook\" | \"slackReaction\" | \"scheduled\" | \"delay\";\n data: {\n // Fields depend on the trigger type\n }\n}\n```\n\n### AutomationStep\n\nEach step in the `steps` array should be an object with a `type` property and a `data` property:\n\n```plaintext\n{\n type: \"action\" | \"branches\";\n data: {\n // Fields depend on the step type\n }\n}\n```\n\n### Response\n\nThe response will be a JSON object representing the created automation, including its ID and other details.\n\n### Notes\n\n- Automations are only available if custom actions are enabled for the tenant.\n\n### Posting shared code library external functions for automations\n\nUse this POST function:\n\n```plaintext\nPOST /automations/functions?projectId=${project ID goes here}\n\n{\n\"code\": \"code goes here...\"\n}\n```\n\nThat should return an object with a version property:\n\n```plaintext\n{\\\n\"version\": 2,\\\n...other properties here\\\n}\n```\n\nThen you'll need to activate the version:\n\n```plaintext\nPOST /automations/functions/${version here}/activate?projectId${project ID here}\n\n{}\n```\n\nThe projectId query param is optional. If this is for *tenant* level automations leave that blank.\n\n\\*\\*\\*If you need to \"roll-back\" a change made through the API you can do so by activating a previous function version.\n\n## Conversation Management\n\n### Add Follower to Conversation\n\n```plaintext\nPOST /conversations/:conversationId/add-follower\n```\n\nThis endpoint will add a follower to the given conversation. The request body should contain the `entityId` of the follower to add and the `entityType` which is either “user” or “group”.\n\n### **Remove Follower from Conversation**\n\n```plaintext\nPOST /conversations/:conversationId/remove-follower\n```\n\nThis endpoint will remove a follower from the given conversation. The request body should contain the `entityId` of the follower to remove.\n\n### Assign Collaborator to Conversation\n\n```plaintext\nPUT /conversations/:conversationId/collaborators/:collaboratorTypeId\n```\n\nThis endpoint will add a collaborator with the given collaborator type to the given conversation. The request body should contain the `entityId` of the collaborator to add and the `entityType` which is either “user” or “group”.\n\n### List Collaborator Types\n\n```plaintext\nPOST /collaborator-types/list;\n```\n\nThis endpoint will return a list of collaborator types.\n\n### Create External Task\n\n```plaintext\nPOST /conversations/:conversationId/external-tasks\n```\n\nSample body:\n\n```plaintext\n{\n \"title\": \"Fix widget export failure\",\n \"description\": \"Customer cannot export CSV from the dashboard.\",\n \"integrationId\": \"linear-task-manager-integration-uuid\",\n \"projectId\": \"linear-project-id\",\n \"assigneeId\": \"linear-user-id\",\n \"providerConfig\": {\n \"linearTeamId\": \"linear-team-id\",\n \"linearLabelIds\": [\"linear-label-id-1\", \"linear-label-id-2\"],\n \"linearPriority\": 2,\n \"linearStatusId\": \"linear-workflow-state-id\",\n \"linearDueDate\": \"2026-06-15\"\n }\n}\n```\n\n## Conversations\n\n### Create Conversation\n\n```plaintext\nPOST / conversations;\n```\n\nThis endpoint will create and return a new conversation. Behavior will differ depending on the `type` field:\n\n- For `type == \"slack\"`, the conversation will be for communication in Slack. You can choose to post the details either into a DM or into a channel.\n- For `type == \"triage\"`, the conversation will be for internal discussion only and there will be no way to communicate with the customer. The `triageChannelId` field is required.\n- For `type == \"email\"`, the conversation will be continued via email replies. Replies in the thread with `/unthread send` appended will be sent to the customer via email. The `emailInboxId` field is required. The `onBehalfOf` field is used to specify the email address and name of the end user to communicate with.\n\nIf `customerId` is provided, the conversation will be linked to the given customer and that customer’s autoresponder and SLA settings will be applied.\n\nRequest schema:\n\n```plaintext\ninterface CreateConversationRequest {\n type: \"triage\" | \"email\" | \"slack\";\n markdown: string;\n status: \"open\" | \"in_progress\" | \"on_hold\" | \"closed\";\n assignedToUserId?: string;\n customerId?: string;\n channelId?: string; // Only required if type == \"slack\". If not provided, the conversation will be continued through the Unthread app for Slack via a DM.\n projectId?: string;\n priority?: 3 | 5 | 7 | 9;\n triageChannelId?: string; // Only required if type == \"triage\"\n notes?: string;\n title?: string;\n excludeAnalytics?: boolean;\n emailInboxId?: string; // Only required if type == \"email\"\n ticketTypeId?: string;\n onBehalfOf?: {\n // Only required if type == \"email\". Either email or id must be provided.\n email?: string;\n name?: string;\n id?: string;\n };\n}\n```\n\n### Attachments\n\nFiles can be attached to the conversation by making a multipart/form-data request instead of a JSON request. The JSON payload should be included as a form field named `json` and the files should be included as additional form fields with the name `attachments` and the file as the value.\n\nSlack enforces a hard limit of **10 file attachments per Slack message** (not per conversation). If you need to attach more than 10 files, split the attachments across multiple messages.\n\nThe maximum file size is 20MB.\n\nSee the following Javascript example for clarification:\n\n```plaintext\nconst formData = new FormData();\n\nformData.append(\n \"json\",\n JSON.stringify({\n type: \"email\",\n markdown: \"Hello, world!\",\n status: \"open\",\n onBehalfOf: {\n email: \"example@unthread.io\",\n name: \"Example User\",\n },\n emailInboxId: \"12345678-1234-1234-1234-123456789abc\",\n })\n);\n\nformData.append(\"attachments\", file1);\nformData.append(\"attachments\", file2);\n\nawait fetch(\"https://api.unthread.io/api/conversations\", {\n method: \"POST\",\n headers: {\n \"X-Api-Key\": \"Bearer YOUR_API_KEY\",\n },\n body: formData,\n});\n```\n\nNotes:\n\n- Markdown should follow the [Slack formatting](https://api.slack.com/reference/surfaces/formatting) guide.\n- For more info on multipart/form-data requests, see the IETF [RFC 7578](https://tools.ietf.org/html/rfc7578).\n\n### Get Conversation by ID\n\n```plaintext\nGET /conversations/:conversationId\n```\n\nThis endpoint will return the given conversation.\n\n### Update Conversation\n\n```plaintext\nPATCH /conversations/:conversationId\n```\n\nThis endpoint will return the updated conversation. Fields that can be updated are:\n\n- `status`\n- `subStatusId`\n- `priority`\n- `notes`\n- `assignedToUserId`\n- `wakeUpAt`\n- `snoozedAt`\n- `excludeAnalytics`\n- `title`\n- `lockedAt`\n- `customerId`\n- `ticketTypeId`\n- `ticketTypeFields`\n- `submitterUserId`\n- `metadata`\n\n### \n\nQuery parameters:\n\n- `useFullContent` (optional): When set to `true`, returns the full content of the conversation in the response. Defaults to `false`.\n- `mergeTicketTypeFields`(optional): When set to `true`, merges the provided `ticketTypeFields` with existing fields instead of replacing them entirely. Defaults to `false`.\n\nExample:\n\n```plaintext\nPATCH /conversations/:conversationId?mergeTicketTypeFields=true\n```\n\n### **List Conversations**\n\n```plaintext\nPOST / conversations / list;\n```\n\nThis endpoint will return a list of conversations.\n\n### List Messages for Conversation\n\n```plaintext\nPOST /conversations/:conversationId/messages/list\n```\n\nThis endpoint will return a list of messages for a given conversation.\n\n### Create Message in Conversation\n\n```plaintext\nPOST /conversations/:conversationId/messages\n```\n\nThis endpoint will post a new message into a Slack thread for a conversation.\n\nSample request:\n\n```plaintext\ninterface Block {\n type: \"section\" | \"survey\";\n text?: {\n text: string;\n type: \"mrkdwn\" | \"plaintext\";\n };\n survey_id?: string;\n}\n\ninterface CreateMessageRequest {\n body?: {\n type: \"html\" | \"markdown\";\n value: string;\n };\n blocks?: Block[];\n markdown?: string; // DEPRECATED: Use 'blocks' and/or 'body' instead\n triageThreadTs?: string; // Slack thread value (e.g. \"1782936472.199649\")\n isPrivateNote?: boolean; // Only applicable for email and in-app chat conversations\n isAutoresponse?: boolean; // Set this to true to treat this as a bot auto-response. Useful when responding to a conversation with your own AI bot.\n onBehalfOf?: {\n email?: string;\n name?: string;\n id?: string;\n };\n}\n```\n\nNotes:\n\n- Either `body`, `blocks` or `markdown` must be provided.\n- If both `blocks` and `body` or `markdown` are provided, the `blocks` will be appended after the `markdown` content\n- Only pass in `triageThreadTs` if you want the message to be posted to a [triage](https://help.unthread.unthread.io/articles/016a0ff3-d7ba-40bc-bbd6-9676c04854db) thread for that conversation rather than being sent to the customer.\n- For email and in-app chat conversations, set `isPrivateNote` to `true` to mark the message as a private note which will post to the Slack thread for the conversation without sending a response back to the customer.\n- File attachments can also be included. See the section on adding attachments when creating a conversation for more information.\n- If `onBehalfOf` is provided, the message will be sent as the given user. If not provided, the message will be sent as the Unthread bot.\n\n### Link Conversations\n\n```plaintext\nPOST /conversations/:conversationId/links\n```\n\nCreate a related to, blocking, or tracking link to a conversation.\n\n```plaintext\ninterface LinkConversationRequest {\n linkedConversationId: string;\n type: 'relatedTo' | 'blocks' | 'blockedBy' | 'tracks' | 'trackedBy'\n}\n```\n\n## Download File Attachment\n\n```plaintext\nGET /conversations/:conversationId/files/:fileId/full\n```\n\nThis endpoint will return the full contents of a file attachment for a given conversation. The `:fileId` can be found in the `files` array of the conversation object.\n\n## \n\n## Customers\n\n### Get Customer by ID\n\n```plaintext\nGET /customers/:customerId\n```\n\nThis endpoint will return the given customer.\n\n### Update Customer\n\n```plaintext\nPATCH /customers/:customerId\n```\n\nThis endpoint will return the updated customer. Fields that can be updated are: `name`, `slackChannelId`, `autoresponder`, `supportSteps`, `defaultTriageChannelId`, `disableAutomatedTicketing`, `primarySupportAssigneeId`, `primarySupportAssigneeType`, `secondarySupportAssigneeId`, `secondarySupportAssigneeType`, `replyTimeoutHours`, `botHandling`, `emailDomains`.\n\n### Create Customer\n\n```plaintext\nPOST / customers;\n```\n\nThis endpoint will return the newly created customer and will create a Slack channel automatically if the `createChannel` flag is set to `true`.\n\n```plaintext\ninterface CreateCustomerRequest {\n name: string;\n slackChannelId?: string;\n emailDomains?: string[];\n tagIds?: string[],\n isPrivate?: boolean;\n inviteUserIds?: string[];\n channelTopic?: string; // max 250 characters\n createChannel?: boolean; // to create a channel in Slack for this customer\n}\n```\n\n### Delete Customer\n\n```plaintext\nDELETE /customers/:customerId\n```\n\nThis endpoint will delete the given customer.\n\n### List Customers\n\nThis endpoint will return a list of customers.\n\n## \n\n## Knowledge Base\n\n### Query Knowledge Base\n\n```plaintext\nPOST / knowledge - base / query;\n```\n\nThis endpoint allows you to make a one-off query to the knowledge base. You can optionally pass various context parameters to influence the query results.\n\nRequest schema:\n\n```plaintext\ninterface QueryKnowledgeBaseRequest {\n query: string; // Required\n customerId?: string; // Optional\n userId?: string; // Optional\n conversationId?: string; // Optional\n}\n```\n\n### Parameters\n\n- `query` (required): The string query to search for in the knowledge base.\n- `customerId` (optional): The ID of the customer associated with this query.\n- `userId` (optional): The ID of the user making the query.\n- `conversationId` (optional): The ID of the conversation context for this query.\n\nExample request:\n\n```plaintext\n{\n \"query\": \"How do I reset my password?\",\n \"customerId\": \"9YQjOSTFXeOPF8xNURFd\",\n \"userId\": \"63335fa9-ffcc-4103-8905-e4440cc7c7d4\",\n \"conversationId\": \"0476bfd0-0c3f-4dfb-b462-d75a4a6908e1\"\n}\n```\n\n### Create Knowledge Base Article\n\n```plaintext\nPOST / knowledge - base / articles;\n```\n\nThis endpoint allows you to create a new article in the knowledge base.\n\nRequest schema:\n\n```plaintext\ninterface CreateKnowledgeBaseArticleRequest {\n title: string; // Required\n content: string; // Required\n url?: string; // Optional\n userGroupIds?: string[]; // Optional\n}\n```\n\n### Parameters:\n\n- `title` (required): The title of the knowledge base article.\n- `content` (required): The content of the knowledge base article.\n- `url` (optional): The URL associated with this article.\n- `userGroupIds` (optional): Array of user group IDs that have access to this article.\n\nExample request:\n\n```plaintext\n{\n \"title\": \"How to Reset Your Password\",\n \"content\": \"To reset your password, go to the login page and click on 'Forgot Password', then follow the instructions sent to your email.\",\n \"url\": \"https://help.example.com/password-reset\",\n \"userGroupIds\": [\"63335fa9-ffcc-4103-8905-e4440cc7c7d4\"]\n}\n```\n\n### Get Knowledge Base Article by ID\n\n```plaintext\nGET /knowledge-base/articles/:articleId\n```\n\nThis endpoint retrieves a specific knowledge base article by its ID.\n\nExample response:\n\n```plaintext\n{\n \"id\": \"63335fa9-ffcc-4103-8905-e4440cc7c7d4\",\n \"title\": \"How to Reset Your Password\",\n \"content\": \"To reset your password, go to the login page and click on 'Forgot Password', then follow the instructions sent to your email.\",\n \"url\": \"https://help.example.com/password-reset\",\n \"status\": \"active\",\n \"userGroupIds\": [\"63335fa9-ffcc-4103-8905-e4440cc7c7d4\"],\n \"createdAt\": \"2023-04-15T14:32:21Z\",\n \"updatedAt\": \"2023-04-16T09:14:07Z\"\n}\n```\n\n### Update Knowledge Base Article\n\n```plaintext\nPATCH /knowledge-base/articles/:articleId\n```\n\nThis endpoint allows you to update an existing article in the knowledge base.\n\nRequest schema:\n\n```plaintext\ninterface UpdateKnowledgeBaseArticleRequest {\n title?: string; // Optional\n content?: string; // Optional\n url?: string; // Optional\n userGroupIds?: string[]; // Optional\n status?: \"active\" | \"inactive\"; // Optional\n}\n```\n\n### Parameters:\n\n- `title` (optional): The updated title of the knowledge base article.\n- `content` (optional): The updated content of the knowledge base article.\n- `url` (optional): The updated URL associated with this article.\n- `userGroupIds` (optional): Updated array of user group IDs that have access to this article.\n- `status` (optional): The status of the article, either “active” or “inactive”.\n\nExample request:\n\n```plaintext\n{\n \"title\": \"Updated: How to Reset Your Password\",\n \"status\": \"inactive\"\n}\n```\n\n### Delete Knowledge Base Article\n\n```plaintext\nDELETE /knowledge-base/articles/:articleId\n```\n\nThis endpoint deletes an article from the knowledge base.\n\n### List Knowledge Base Articles\n\n```plaintext\nPOST / knowledge - base / articles / list;\n```\n\nThis endpoint will return a list of knowledge base articles following the standard list conventions. Example request:\n\n```plaintext\n{\n \"select\": [\"id\", \"title\", \"url\", \"status\"],\n \"order\": [\"createdAt\"],\n \"where\": [\n {\n \"field\": \"status\",\n \"operator\": \"==\",\n \"value\": \"active\"\n }\n ],\n \"descending\": true,\n \"limit\": 10\n}\n```\n\n## Outbound Messages\n\n### Create and/or send an outbound message\n\n```plaintext\nPOST / outbounds;\n```\n\nThis endpoint will create an outbound and send it, unless the status is set to “draft”. Drafts can be sent later by updating the status to “scheduled”.\n\n### Update and/or send an outbound message\n\n```plaintext\nPATCH /outbounds/:outboundId\n```\n\nThis endpoint will update an outbound. Drafts can be sent by updating the status to “scheduled”.\n\n### List outbounds\n\n```plaintext\nGET / outbounds;\n```\n\nThis endpoint will list all outbounds.\n\n### Get outbound by ID\n\n```plaintext\nGET /outbounds/:outboundId\n```\n\nThis endpoint will return the given outbound.\n\n## \n\n## Reporting\n\n```plaintext\nPOST / reporting / time - series;\n```\n\nThis endpoint will return metrics about your conversations. Requests are made in the following format:\n\n```plaintext\ntype Metric = \"totalCount\" | \"responseTimeMean\" | \"responseTimeWorkingMean\" | \"resolutionTimeMean\" | \"resolutionTimeWorkingMean\" | \"conversationsResolved\";\ntype DateDimension = \"day\" | \"week\" | \"month\";\ntype Dimension = \"assigneeId\" | \"customerId\" | \"tagId\" | \"sourceType\";\n\ninterface ReportingTimeSeriesRequest {\n timezone?: string;\n startDate: string;\n endDate: string;\n dateDimension?: DateDimension;\n metric: Metric;\n dimensions?: Dimension[];\n filters?: {\n [dim: Dimension]: string | string[];\n };\n}\n```\n\n- The `timezone` field is optional and defaults to “UTC”.\n- `startDate` and `endDate` have the following format: “2022-12-31”. The dates are inclusive.\n- `dateDimension` specifies the time period in which the data should be grouped.\n- All metrics are numbers. Response and resolution times are in seconds.\n- `dimensions` is an array of fields to group the data by in addition to the date.\n- `filters` allows you to filter the data to specific dimensions. If an array is passed for a given dimension, then it is treated as an `OR`.\n\nResponses are returned in the following format:\n\n```plaintext\ntype Dimension = \"assigneeId\" | \"customerId\" | \"tagId\" | \"sourceType\";\n\ntype DataSplit = {\n [key: string]: DataPoint;\n};\ntype DataPoint = number | Data: Split;\n\ninterface ReportingTimeSeriesResponse {\n data: DataSplit;\n dates: string[];\n lookups: {\n [dim: Dimension]: {\n [key: string]: string;\n };\n };\n}\n```\n\n- If there is no data for a particular day, then that day will not be included in the `data` object; however, it will be included in the `dates` array.\n- If dimensions are included in the request, then the data will be nested for each dimension included. Dimensions are nested in the order they are included in the request. See the example below for clarification.\n- `dates` is an array of the time periods covered by the query. For grouping by weeks, each value in the array is the first day of the week starting on Monday. For grouping by months, each value in the array is the first day of the month.\n- `lookups` contains friendly names for the keys contained in `data`. For example, if grouping by `customerId`, the lookups would contain a mapping from the customer ID to the customer name.\n\n### \n\nAn example request and response are included below:\n\n```plaintext\n// Request\n// POST /reporting/time-series\n{\n \"dateDimension\": \"week\",\n\t\"startDate\": \"2022-12-01\",\n\t\"endDate\": \"2022-12-31\",\n\t\"metric\": \"totalCount\",\n\t\"timezone\": \"America/New_York\",\n\t\"filters\": {\n\t\t\"assigneeId\": [\n\t\t\t\"63335fa9-ffcc-4103-8905-e4440cc7c7d4\",\n\t\t\t\"2e8dab53-a7a2-4e1f-b9d9-66018b98365d\"\n\t\t]\n\t},\n\t\"dimensions\": [\"customerId\", \"sourceType\"]\n}\n\n// Response\n{\n \"lookups\":{\n \"customerId\":{\n \"9YQjOSTFXeOPF8xNURFd\": \"Customer 1\",\n \"AWEpBY0uqxfp73HaTVS4\": \"Customer 2\",\n\t\t\t \"aZHO2af1RFa92QiOq3Y4\": \"Customer 3\"\n },\n \"sourceTypes\":[]\n },\n \"dates\":[\n \"2022-11-28\",\n \"2022-12-05\",\n \"2022-12-12\",\n \"2022-12-19\",\n \"2022-12-26\"\n ],\n \"data\":{\n \"9YQjOSTFXeOPF8xNURFd\":{\n \"slack\":{\n \"2022-11-28\":19,\n \"2022-12-12\":70,\n \"2022-12-19\":17\n },\n\t\t\t \"widget\":{\n \"2022-11-28\":6,\n \"2022-12-12\":1\n }\n },\n \"AWEpBY0uqxfp73HaTVS4\":{\n \"email\":{\n \"2022-12-31\":1\n },\n\t\t\t \"slack\":{\n \"2022-11-28\":6,\n \"2022-12-12\":1\n }\n },\n \"aZHO2af1RFa92QiOq3Y4\":{\n \"slack\":{\n \"2022-11-28\":6,\n \"2022-12-12\":1\n }\n }\n }\n}\n```\n\n## Surveys\n\n```plaintext\nList surveys: POST /surveys/list\nList survey responses: POST /surveys/:surveyId/responses/list\nGet survey analytics (CSAT): GET /surveys/:surveyId/analytics\n```\n\n## Slack Integration\n\n### Update Slack User Group\n\n```plaintext\nPATCH /slack/usergroup\n```\n\nThis endpoint updates a Slack user group.\n\nParameters:\n\n- `email` (required): The email address of the user to update.\n- `slackHandle` (required): The Slack handle of the user to update.\n\nExample request:\n\n```plaintext\n{\n \"email\": \"test@example.com\",\n \"slackHandle\": \"test\"\n}\n```\n\n## \n\n## Tags\n\n### Get Tag by ID\n\n```plaintext\nGET /tags/:tagId\n```\n\nThis endpoint will return the given tag.\n\n### Update Tag\n\n```plaintext\nPATCH /tags/:tagId\n```\n\nThis endpoint will return the updated tag. Fields that can be updated are: `name`.\n\n### Create Tag\n\n```plaintext\nPOST / tags;\n```\n\nThis endpoint will return the newly created tag. Fields that can be updated or set on create are: `name`\n\n### Delete Tag\n\n```plaintext\nDELETE /tags/:tagId\n```\n\nThis endpoint will delete the given tag.\n\n### List Tags\n\n```plaintext\nPOST / tags / list;\n```\n\nThis endpoint will return a list of tags.\n\n### Add Tag to Customers\n\n```plaintext\nPOST /tags/:tagId/customers/create-links\n```\n\nThis endpoint takes an array of customer IDs and will assign the given tag to all the specified customers.\n\nSample request body: `[ '93ba5298-a23f-413b-94fe-73e0ab26a816', '7ab46970-19ec-492e-90fe-47a8abc93fec' ]`\n\n### Add Tag to Conversations\n\n```plaintext\nPOST /tags/:tagId/conversations/create-links\n```\n\nThis endpoint takes an array of conversation IDs and will assign the given tag to all the specified conversations.\n\nSample request body: `[ 'ad00e2d0-4ea4-45c4-9b5d-8728f93e51a7', 'e82cde04-0d59-4416-b5da-1f405f6d4ddb' ]`\n\n### Remove Tag from Customers\n\n```plaintext\nPOST /tags/:tagId/customers/delete-links\n```\n\nThis endpoint takes an array of customer IDs and will remove the given tag from all the specified customers.\n\n### Remove Tag from Conversations\n\n```plaintext\nPOST /tags/:tagId/conversations/delete-links\n```\n\nThis endpoint takes an array of conversation IDs and will remove the given tag from all the specified conversations.\n\n## Ticket Types\n\n### Create Ticket Type\n\n```plaintext\nPOST / ticket - types;\n```\n\nThis endpoint creates a new ticket type. Example request body:\n\n```plaintext\n{\n \"name\": \"Access Request\",\n \"description\": \"A request for access to a resource\",\n \"fields\": [\n {\n \"id\": \"12345678-1234-1234-1234-123456789abc\",\n \"name\": \"Application\",\n \"type\": \"single-select\",\n \"required\": true,\n \"options\": [\"Salesforce\", \"Slack\"]\n },\n {\n \"id\": \"42345678-1234-1234-1234-123456789abd\",\n \"name\": \"Access Level\",\n \"type\": \"single-select\",\n \"required\": true,\n \"options\": [\"Admin\", \"User\"],\n \"conditions\": {\n \"type\": \"simple\",\n \"simple\": {\n \"leftValueFrom\": \"conversation.ticketTypeFields['12345678-1234-1234-1234-123456789abc']\",\n \"operator\": \"equals\",\n \"rightValue\": \"Salesforce\"\n }\n }\n }\n ]\n}\n```\n\n### Update Ticket Type\n\n```plaintext\nPATCH /ticket-types/:ticketTypeId\n```\n\nThis endpoint updates a ticket type.\n\n### Delete Ticket Type\n\n```plaintext\nDELETE /ticket-types/:ticketTypeId\n```\n\nThis endpoint deletes a ticket type.\n\n### List Ticket Types\n\n```plaintext\nPOST / ticket - types / list;\n```\n\nThis endpoint lists all ticket types.\n\n### Get Ticket Type\n\n```plaintext\nGET /ticket-types/:ticketTypeId\n```\n\nThis endpoint gets a ticket type.\n\n## Users\n\n### List Users\n\n```plaintext\nPOST / users / list;\n```\n\nThis endpoint will return a list of users who are a member of your Slack workspace and have been synced into Unthread.\n\nTo return external users, pass in the `includeExternalUsers` field with a value of `true`.\n\n### Get User by ID\n\n```plaintext\nGET /users/:userId\n```\n\nThis endpoint will return the given user.\n\n### Update User by ID\n\n```plaintext\nPATCH /users/:userId\n```\n\nThis endpoint will return the given user. Supported fields on update:\n\n- `name`\n- `pronoun`\n- `title`\n- `department`\n- `organization`\n- `division`\n- `costCenter`\n- `employeeNumber`\n- `streetAddress`\n- `locality`\n- `region`\n- `postalCode`\n- `country`\n- `description`\n- `customAttributes`\n- `photo`\n- `awayUntil`\n\n### List User Groups\n\n```plaintext\nPOST /user-groups/list\n```\n\n### Get User Group\n\n```plaintext\nGET /user-groups/:userGroupId\n```\n\n### Update User Group\n\n```plaintext\nPATCH /user-groups/:userGroupId\n```\n\n## Webhooks\n\n### Create Webhook Subscription\n\n```plaintext\nPOST / webhook - subscriptions;\n```\n\nThis endpoint will return the newly created webhook subscription. Fields that can be set on create are: `url` and `enabled`.\n\n### Update Webhook Subscription\n\n```plaintext\nPATCH /webhook-subscriptions/:webhookSubscriptionId\n```\n\nThis endpoint will return the updated webhook subscription. Fields that can be updated are: `url` and `enabled`.\n\n### Delete Webhook Subscription\n\n```plaintext\nDELETE /webhook-subscriptions/:webhookSubscriptionId\n```\n\nThis endpoint will delete the given webhook subscription.\n\n### List Webhook Subscriptions\n\n```plaintext\nGET / webhook - subscriptions;\n```\n\nThis endpoint will return a list of webhook subscriptions.\n\n## Service-Level Agreements (SLAs)\n\nThese endpoints accept service account API keys. SLA functionality must be enabled for the workspace, and the service account must have access to the relevant workspace or project. SLA policy write operations require a workspace owner/admin service account, or a project service account with permission to manage project settings.\n\n### SLA policy and instance objects\n\n```plaintext\ntype SlaMetricType =\n | \"first_response\"\n | \"resolution\"\n | \"next_reply\"\n | \"escalation_acknowledgement\"\n | \"escalation_closed\";\n\ntype SlaPolicyStatus = \"active\" | \"inactive\";\ntype SlaPriorityChangeBehavior =\n | \"adjust_target\"\n | \"reset\"\n | \"keep_original\";\n\ninterface SlaMetricTarget {\n targetMinutes: number;\n warningMinutes?: number;\n useBusinessHours: boolean;\n}\n\ninterface SlaPolicyMetric {\n id: string;\n metricType: SlaMetricType;\n targets: Record<\"_default\" | string, SlaMetricTarget>;\n}\n\ninterface SlaPolicy {\n id: string;\n projectId: string | null;\n name: string;\n description: string | null;\n status: SlaPolicyStatus;\n onPriorityChange: SlaPriorityChangeBehavior;\n metrics: SlaPolicyMetric[];\n createdAt: string;\n updatedAt: string;\n}\n\ntype SlaInstanceStatus =\n | \"running\"\n | \"paused\"\n | \"breached\"\n | \"completed\"\n | \"cancelled\";\n\ninterface SlaInstance {\n id: string;\n conversationId: string;\n metricType: SlaMetricType | null;\n status: SlaInstanceStatus;\n startedAt: string;\n deadlineAt: string;\n warningAt: string | null;\n breachedAt: string | null;\n completedAt: string | null;\n elapsedPausedMinutes: number;\n policyName: string | null;\n slaPolicyId: string | null;\n useBusinessHours: boolean | null;\n}\n```\n\nEach `targets` key is either `_default` or a stringified conversation priority such as `\"1\"`. `targetMinutes` must be a positive integer. When supplied, `warningMinutes` must be a positive integer smaller than `targetMinutes`.\n\n### Create an SLA policy\n\n```plaintext\nPOST /sla-policies\n```\n\nCreates a workspace-wide policy when `projectId` is null or omitted, or a project-scoped policy when `projectId` is provided.\n\n```plaintext\n{\n \"name\": \"Standard support\",\n \"description\": \"Default response and resolution targets\",\n \"projectId\": \"e9ce1893-1a81-419e-abc6-8898f4532b56\",\n \"status\": \"active\",\n \"onPriorityChange\": \"adjust_target\",\n \"metrics\": [\n {\n \"metricType\": \"first_response\",\n \"targets\": {\n \"_default\": {\n \"targetMinutes\": 60,\n \"warningMinutes\": 45,\n \"useBusinessHours\": true\n },\n \"1\": {\n \"targetMinutes\": 15,\n \"warningMinutes\": 10,\n \"useBusinessHours\": true\n }\n }\n }\n ]\n}\n```\n\nReturns the created `SlaPolicy` with HTTP 201. A policy can contain one metric of each metric type.\n\n### List SLA policies\n\n```plaintext\nPOST /sla-policies/list\n```\n\nUses the standard list endpoint conventions. Service accounts need a non-viewer role.\n\n```plaintext\n{\n \"select\": [\n \"id\",\n \"projectId\",\n \"name\",\n \"description\",\n \"status\",\n \"onPriorityChange\",\n \"metrics.id\",\n \"metrics.metricType\",\n \"metrics.targets\",\n \"createdAt\",\n \"updatedAt\"\n ],\n \"where\": [\n { \"field\": \"status\", \"operator\": \"==\", \"value\": \"active\" }\n ],\n \"order\": [\"name\"],\n \"limit\": 100\n}\n```\n\nSupported order fields: `name`, `projectId`, `createdAt`, and `updatedAt`. Supported filter fields: `id`, `name`, `projectId`, and `status`.\n\n### Get an SLA policy\n\n```plaintext\nGET /sla-policies/:slaPolicyId\n```\n\nReturns the requested `SlaPolicy`. Use the optional `select` query parameter to return a comma-separated subset of fields.\n\n### Update an SLA policy\n\n```plaintext\nPATCH /sla-policies/:slaPolicyId\n```\n\nUpdates any supplied policy fields. Include a metric `id` to update that metric in place; omit the ID to create a replacement metric.\n\n```plaintext\n{\n \"name\": \"Updated support targets\",\n \"status\": \"active\",\n \"onPriorityChange\": \"keep_original\",\n \"metrics\": [\n {\n \"id\": \"8dbf1a97-7ee0-4d23-9c5f-a479717a48cb\",\n \"metricType\": \"first_response\",\n \"targets\": {\n \"_default\": {\n \"targetMinutes\": 45,\n \"warningMinutes\": 30,\n \"useBusinessHours\": true\n }\n }\n }\n ]\n}\n```\n\nReturns the updated `SlaPolicy`.\n\n### Delete an SLA policy\n\n```plaintext\nDELETE /sla-policies/:slaPolicyId\nDELETE /sla-policies/:slaPolicyId?confirm=true\n```\n\nIf the policy is referenced, the first request returns HTTP 409 with `code: \"SLA_POLICY_DELETE_REQUIRES_CONFIRMATION\"` and reference counts. Repeat with `confirm=true` to confirm deletion. A successful deletion returns HTTP 204.\n\n### List SLA instances\n\n```plaintext\nPOST /sla-instances/list\n```\n\nReturns SLA instances across conversations visible to the service account. Workspace owner, admin, or standard access is required. In addition to standard list fields, the request supports `conversationId`, `status`, `metricType`, and `dateRange` shortcuts.\n\n```plaintext\n{\n \"status\": [\"running\", \"paused\", \"breached\"],\n \"metricType\": \"first_response\",\n \"dateRange\": {\n \"field\": \"deadlineAt\",\n \"start\": \"2026-08-01T00:00:00.000Z\",\n \"end\": \"2026-08-31T23:59:59.999Z\"\n },\n \"order\": [\"deadlineAt\"],\n \"limit\": 100\n}\n```\n\n`dateRange.field` may be `startedAt`, `deadlineAt`, `warningAt`, `breachedAt`, `completedAt`, `createdAt`, or `updatedAt`. The default is `deadlineAt`.\n\n### List SLA instances for a conversation\n\n```plaintext\nPOST /conversations/:conversationId/sla-instances/list\n```\n\nReturns SLA instances for one visible conversation and supports the same filters as the workspace-wide instance list. Workspace owner, admin, standard, and viewer service accounts can call this endpoint.\n\n### Assign SLA policies\n\nThe following existing endpoints are also open to service accounts. Send a policy ID to assign it, or `null` to clear it:\n\n- `PATCH /conversations/:conversationId` with `{ \"slaPolicyId\": \"...\" }`\n- `PATCH /customers/:customerId` with `{ \"slaPolicyId\": \"...\" }`\n- `PATCH /accounts/:accountId` with `{ \"slaPolicyId\": \"...\" }`\n- `PATCH /projects/:projectId` with `{ \"defaultSlaPolicyId\": \"...\" }`\n\nProject, customer, and account policies provide defaults for new conversations. A conversation's explicit `slaPolicyId` controls its active policy after creation.","2023-12-03T18:55:47.916Z","2026-08-06T17:32:16.099Z","72d90ae5-34de-42da-ad47-64b60c6b0d09",[],[],[],"Analytics","analytics","bar-chart","2025-09-09T20:08:44.731Z","2025-10-08T20:19:55.221Z","a45d37f7-afe5-49cf-836a-6c15ba59769b",9,[388,389,390,391,392,393,394,395,396],[],{"_57":468,"_118":469,"_138":-5,"_139":470,"_141":384,"_142":-5,"_143":471,"_145":472,"_22":473,"_24":25,"_120":474,"_150":-5,"_151":475,"_153":476},{"_57":459,"_118":460,"_138":-5,"_139":461,"_141":384,"_142":-5,"_143":462,"_145":463,"_22":464,"_24":25,"_120":465,"_150":-5,"_151":466,"_153":467},{"_57":450,"_118":451,"_138":-5,"_139":452,"_141":384,"_142":-5,"_143":453,"_145":454,"_22":455,"_24":25,"_120":456,"_150":-5,"_151":457,"_153":458},{"_57":441,"_118":442,"_138":-5,"_139":443,"_141":384,"_142":-5,"_143":444,"_145":445,"_22":446,"_24":25,"_120":447,"_150":-5,"_151":448,"_153":449},{"_57":432,"_118":433,"_138":-5,"_139":434,"_141":384,"_142":-5,"_143":435,"_145":436,"_22":437,"_24":25,"_120":438,"_150":-5,"_151":439,"_153":440},{"_57":423,"_118":424,"_138":-5,"_139":425,"_141":384,"_142":-5,"_143":426,"_145":427,"_22":428,"_24":25,"_120":429,"_150":-5,"_151":430,"_153":431},{"_57":414,"_118":415,"_138":-5,"_139":416,"_141":384,"_142":-5,"_143":417,"_145":418,"_22":419,"_24":25,"_120":420,"_150":-5,"_151":421,"_153":422},{"_57":406,"_118":-5,"_138":-5,"_139":407,"_141":384,"_142":-5,"_143":408,"_145":409,"_22":410,"_24":25,"_120":411,"_150":-5,"_151":412,"_153":413},{"_57":397,"_118":398,"_138":-5,"_139":399,"_141":384,"_142":-5,"_143":400,"_145":401,"_22":402,"_24":25,"_120":403,"_150":-5,"_151":404,"_153":405},"Volume Analytics","volume-analytics","## Introduction\n\nNavigate to **Analytics > Volume** to view conversation volume metrics and understand your support team’s workload patterns. Every support team has its busy seasons and quiet moments. Volume analytics help you spot patterns in conversation volumes and understand your workload trends over time.\n\n## Key Report Types\n\n- **Message Volume** - Total number of messages received or sent within a period\n- **Daily Averages** - Average message volume per day\n- **Day of Week Analysis** - Volume patterns by day of the week\n- **Hourly Breakdown** - Volume patterns by hour of the day\n\n**ℹ️** *Volume analytics help you plan staffing, identify peak support hours, and understand seasonal patterns in customer inquiries.*\n\n## Understanding Your Data\n\n### Message Volume Trends\n\nTrack the total number of conversations and messages over time to identify:\n\n- Peak support periods\n- Seasonal patterns\n- Growth trends\n- Channel-specific volume differences\n\n### Daily and Hourly Patterns\n\nAnalyze your data by day of week and hour to:\n\n- Plan optimal staffing schedules\n- Identify when customers need support most\n- Balance workload across your team\n- Prepare for busy periods\n\n### Channel Performance\n\nCompare volume across different channels (Slack, email, in-app chat) to:\n\n- Understand customer preferences\n- Allocate resources effectively\n- Optimize channel-specific processes\n\n### Daily Operations\n\nReview volume analytics as part of your daily routine to:\n\n- Understand current workload\n- Plan team capacity\n- Identify unusual spikes in volume\n- Monitor channel distribution\n\n### Weekly Planning\n\nUse weekly volume data to:\n\n- Plan staffing for the upcoming week\n- Identify recurring patterns\n- Adjust processes based on volume trends\n- Celebrate volume milestones\n\n### Monthly Analysis\n\nLeverage monthly volume insights for:\n\n- Strategic planning\n- Resource allocation\n- Process optimization\n- Performance benchmarking\n\n## Related Pages\n\n- [Performance Analytics](https://docs.unthread.io/docs/analytics/performance-analytics)\n- [Board Builder](https://docs.unthread.io/docs/analytics/board-builder)\n- [Analytics Overview](https://docs.unthread.io/docs/analytics/analytics-overview)","2025-09-09T18:48:12.938Z","2026-05-13T21:00:36.327Z","38dfaed6-c54a-4cf1-b2a0-115afdf4bf0e",[],[],[],"Scheduling Emailed Reports","To schedule emails of **Reports** and **Boards** create an automation with the Trigger of Scheduled.\n\n- Set your cadence for email delivery - Daily, Weekly, Monthly, or Custom\n- Set the time of day for email delivery\n- Add a \"**Send Report**\" step to the automation\n- Select the Report or Board you would like to schedule send\n- Select the individual or group you would like the scheduled email delivered to\n- Add an email subject\n\n![image.png](/api/knowledge-base/images/a13758b3-4799-4971-a39c-17a4e0564191)","2026-05-21T20:04:29.628Z","2026-05-21T20:05:14.523Z","3c1ae11e-238e-4e26-9585-1da02abc623c",[],[],[],"Performance Analytics","performance-analytics","## Introduction\n\nPerformance analytics allow you to visualize tickets by grouping them using different values. These reports help you understand how your team is performing across various metrics and identify areas for improvement.\n\nUnthread includes a range of out-of-the-box report types to help teams track key support metrics and gain insights into their support operations.\n\n## Report Types\n\nBefore reviewing these variables, we’ll review the different report types available in performance analytics.\n\nYou’ll notice that some of these report types have two variables:\n\n- **P95 and P99** represent the 95th and 99th percentiles of response times, respectively. This means that 95% (or 99%) of requests are completed within the reported P95 (or P99) latency.\n\n# \n\n## Core Performance Metrics\n\n- **Conversations Created:** Total number of tickets opened\n\n- **First Response (FR) Time** (in minutes): Time between ticket creation and first response by an Agent. A teammate’s response won’t be counted as a first response. Agents can use emoji triggers to manually set the FR message.\n\n- **Resolution Time** (in minutes): Time between ticket getting created and resolved. -If a ticket gets created at t0, closed at t1, re-opened at t3, and re-closed at t4, the resolution time will be the time between t0 and t4\n\n- **Waiting on Customer Time**: Total amount of time the ticket is in Open status\n\n- **Waiting on Agent Time**: Total amount of time the ticket is in In Progress status\n\n- **Ticket Active Duration**: Total amount of time the ticket is in In Progress or Open status type\n\n### Which metric captures an accurate resolution time on a ticket that is closed and then re-opened?\n\nTicket Active Duration excludes time when the ticket is in the closed status before it is re-opened again.\n\n## Escalation Reports\n\n- **Ticket to Escalation Time**: Time from ticket creation to when it’s escalated by a team member\n\n- **Escalation to Acknowledgement Time**: Time between when an escalation is created and when it’s acknowledged by the partner team\n\n- **Acknowledgement to Resolution Time**: Time from when the escalation is acknowledged to when it’s resolved. **Note: This refers specifically to the resolution of the escalation, not the main ticket. Unless automated, resolving an escalation does not automatically resolve the parent ticket.**\n\n ![analytics-ReportTypes.png](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2Fanalytics-ReportTypes.png?alt=media)\n\n## Filtering and Breakdowns\n\nAll dashboards are fully filterable by default attributes like assignee, date range, tags, ticket type, and status, as well as any custom fields tied to your ticket types. Use the filters at the top of each report to drill down by time, submitters, or specific properties.\n\n![analytics-filters.png](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2Fanalytics-filters.png?alt=media)\n\nIn addition to filtering, Unthread offers advanced breakdowns to give teams more granular insights.\n\n![analytics-breakdown.png](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2Fanalytics-breakdown.png?alt=media)\n\nEach report type also includes a table view, displaying the data broken down by your selected time intervals for easy analysis.\n\n![analytics-table.png](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2Fanalytics-table.png?alt=media)\n\n## Key Performance Insights\n\n### First Response Time\n\nYour customers’ first impression of your support often comes down to one thing: how quickly you respond. Analytics helps you track this critical metric from the moment a conversation starts, showing you exactly how quickly your team is serving up solutions.\n\nStart by exploring your first response times—this tells you how long customers wait before getting their first reply. Then dive into resolution times to see how efficiently your team closes out issues.\n\n### Resolution Time\n\nTrack how efficiently your team closes out issues and meets customer needs. Monitor trends to identify process improvements and training opportunities.\n\n### Waiting on Agent Time\n\nUnderstand bottlenecks in your support process by tracking how long tickets wait for agent attention. Use this data to optimize staffing and workflow.\n\n## Breaking Down Results\n\nIn this section, we’ll dive into how our report viewer can be used to drill down into specific data.\n\nFor the purposes of this walkthrough, we’ll use the “Conversation Created” report.\n\nWhen viewing any report, you’ll find a number of categories above the chart which can be used to group the data presented. For example, you can select “source” to visualize all conversations created by their source, be it Slack, email, or otherwise.\n\nYou can also apply this grouping to any custom fields you have configured.\n\n## Chart Visualization Options\n\nThese charts can be visualized in a few ways. You can change this by selecting chart options below the default line chart:\n\n- **Bar Chart** - Useful for comparing different categories\n- **Card View** - Presents you with the actual values for the dataset\n- **Line Chart** - Default view, great for trends over time\n\n**Show Legend** will display the categories for a given selection and will allow you to remove categories from the view by clicking on them.\n\nFinally, you can view this with **working hours enabled**, which will only pull metrics for tickets created during your configured working hours.\n\n**ℹ️** *These working hours can be set at the project level, so you want to be sure each project aligns with the hours the corresponding team provides support in order to keep the data from being skewed incorrectly. To set your working hours, go to \"Setup\" > \"Project Settings\" for your project.*\n\n## Sharing and Exporting Reports\n\n### Saving Reports\n\nIf you have a report that you view frequently, we recommend saving this report. To do so, configure the report with the format that is most helpful and then click the save option in the top right.\n\nSaving these reports will also allow you to use the chart in the board builder.\n\n### Sharing Reports\n\nShare your performance reports with team members, stakeholders, or executives to keep everyone informed about your support team’s performance. Shared reports update automatically, so everyone always sees the latest data.\n\nTo share a report:\n\n1. Open any saved report\n2. Click the “Share” button in the top right\n3. Copy the generated link\n4. Send the link to your intended recipients\n\n**ℹ️** *Shared reports maintain all your filters and settings, so recipients see exactly the same view you’ve configured.*\n\n### Exporting Data\n\nDownload your performance data as CSV files for external analysis, presentations, or reporting to stakeholders. This is perfect for:\n\n- Creating custom reports in Excel or Google Sheets\n- Sharing data with external stakeholders\n- Archiving performance data for historical analysis\n- Creating presentations for executive reviews\n\nTo export data:\n\n1. Configure your report with the desired filters and date range\n2. Save the report, if desired.\n3. Click the download button in the top right\n\n## Related Pages\n\n- [Analytics Overview](https://docs.unthread.io/docs/analytics/analytics-overview)\n- [Board Builder](https://docs.unthread.io/docs/analytics/board-builder)","2025-09-09T18:48:11.194Z","2026-08-14T18:05:14.118Z","29437d5b-06f8-4209-bec3-8a23e11413cf",[],[],[],"Excluding conversations from Analytics Data","excluding-conversations-from-analytics-data","## How to bulk exclude conversations from your Analytics\n\nIf you have older test conversations and data that you would like to exclude from your Analytics you can do so in bulk or on a per conversation basis.\n\n- Navigate to the inbox view of the dashboard\n- To bulk exclude conversations select all and then select \"More\" and choose the \"exclude from Analytics\" option\n\n![Unthread - 25 June 2026 (1) (1).gif](/api/knowledge-base/images/b5f1a593-c11b-4899-82fc-16698d1b09f3)\n\n## How to exclude individual conversations from your Analytics\n\n- Navigate to the conversation within the Unthread dashboard\n- Click the ... for more options at the top\n- Select \"exclude from Analytics\"\n\n![1894 Question about stale conversation prompt – Unthread - 25 June 2026.gif](/api/knowledge-base/images/d3e35203-bcaa-4b07-94f5-248f1ea4e790)","2026-06-25T14:51:25.780Z","2026-06-25T17:08:26.014Z","883ae09a-fefa-47d4-9081-9aef59d7f44a",[],[],[],"Channel Health Scores","health-scores","![CleanShot 2026-05-08 at 15.18.38@2x.png](/api/knowledge-base/images/bf0c87a5-b77c-4fa3-bb9f-68ceaa2fce60)\n\nHealth scores help teams quickly understand which customer or support channels may need attention. Each score is calculated on a 0-100 scale, where higher means healthier and lower means more risk.\n\n## **What the Score Measures**\n\nPulse starts every channel at 100, then subtracts penalties for risk signals found in the selected reporting window.\n\nThe main score factors are:\n\n| **Factor** | **What it measures** | **Max penalty** |\n| --- | --- | --- |\n| Sentiment pressure | Average ticket sentiment below neutral | 20 |\n| High-severity load | Share of tickets marked high priority or above | 25 |\n| Unresolved backlog | Share of tickets not closed | 20 |\n| Volume spike | Ticket volume increase vs the prior same-length period | 15 |\n| Repeat issue concentration | One ticket type dominating more than 50% of volume | 20 |\n| Poor survey feedback | Low CSAT/NPS responses linked to tickets | 30 |\n\nFinal score:\n\n`Health score = 100 - total penalties`\n\nThe final value is rounded and kept between 0 and 100.\n\n## **How Each Factor Works**\n\nPulse compares tickets in the current date range against the prior same-length date range.\n\nFor example, if the current range is the last 30 days, Pulse compares it to the 30 days before that.\n\nA few important details:\n\n- Missing sentiment does not hurt the score.\n- Neutral or positive sentiment does not add a penalty.\n- CSAT and NPS are converted to a shared 0-100 satisfaction scale.\n- No survey responses means no survey penalty.\n- Channels with no reportable tickets in the selected range will not have health data yet.\n- Top tag is shown for context, but it does not directly affect the score.\n- Top ticket type can affect the score when one type makes up more than half of volume.\n\nProject owners can also add scoring priorities. These adjust how much Pulse emphasizes or de-emphasizes each factor, while keeping every factor within its normal cap.\n\n## **Trend and Risk Labels**\n\nPulse also compares the current score to the prior score.\n\n- Improving: current score is more than 5 points higher\n- Worsening: current score is more than 5 points lower\n- Flat: score changed by 5 points or less\n\nRisk labels are based on the score and the underlying risk mix:\n\n- Healthy: score is 80 or higher\n- Monitor: moderate score without severe risk concentration\n- Needs attention: score below 70 with a high share of severe tickets\n- Churn risk: score below 50 with more than 30% unresolved tickets\n- Critical: same as churn risk, but used for internal support projects\n\n## **How Often Scores Are Calculated**\n\nYou can set a default period for calculation, with 30 days being the default. These are calculated continuously so you should always be seeing the most up-to-date information in your channel list.\n\n## **Example Calculation**\n\nA channel has 10 tickets in the selected range:\n\n- Average sentiment is 40 out of 100\n- 3 tickets are high severity\n- 4 tickets are unresolved\n- Volume is flat vs the prior period\n- One ticket type represents 60% of volume\n- Survey satisfaction is healthy\n\nPulse might calculate:\n\n`Sentiment penalty: 4`\\\n`High-severity penalty: 7.5`\\\n`Unresolved penalty: 8`\\\n`Volume spike penalty: 0`\\\n`Repeat issue penalty: 4`\\\n`Survey penalty: 0`\\\n\\\n`Total penalty: 23.5`\\\n`Health score: 100 - 23.5 = 76.5, rounded to 77`\n\n## **Common Use Cases**\n\nUse Pulse health scores to:\n\n- Prioritize which customer channels need attention first\n- Spot volume spikes before they become escalations\n- Identify recurring issues by reviewing top ticket types and tags\n- Track whether a channel is improving after an intervention\n- Prepare for customer check-ins, QBRs, or internal service reviews\n- Find internal support queues with unresolved backlog or high-severity load\n- Compare channel health across a project using the same date range","2026-05-08T19:17:51.282Z","2026-05-11T18:59:22.859Z","3956715e-42e1-4faa-aeed-ca0489d2becb",[],[],[],"Board Builder","board-builder","![exec-dashboard.png](/api/knowledge-base/images/e26bdcef-c1a4-4fc4-965b-a8cb542df659)\n\n## Introduction\n\nNavigate to **Analytics > Dashboards** section to create powerful live dashboards by combining existing reports.\n\nOur Board Builder allows you to combine saved reports into a single view. You can use these boards to track metrics that are most important to you or use the TV Mode feature to output this to a display for real-time updates.\n\n**ℹ️** _Board Builder is perfect for executives and stakeholders who need a high-level view of your support operations at a glance._\n\n## Creating Your Dashboard\n\n### Step 1: Open the Dashboard Builder\n\n1. Go to **Analytics > Dashboards** in your dashboard\n2. Click “Create New Board” to start building\n3. Give your board a descriptive name\n\n### Step 2: Add Reports\n\n1. Select from your saved reports\n2. Choose the layout and positioning for each report\n3. Configure display options for each widget\n\n### Step 3: Customize Your View\n\n- **Layout Options** - Choose from grid layouts to arrange your reports\n- **Size Controls** - Resize reports to emphasize important metrics\n- **Auto-refresh** - Set refresh intervals for real-time updates\n\n![Analytics-Dashboard.png](/api/knowledge-base/images/7dd40f4e-0ddf-4b93-a8b3-821c9cefaf0c)\n\n## TV Mode\n\nUse TV Mode to display your dashboard on a monitor or TV screen for:\n\n- **Team visibility** - Keep everyone informed of current metrics\n- **Real-time monitoring** - Display live updates during busy periods\n- **Executive dashboards** - Provide leadership with key insights\n- **War rooms** - Centralized monitoring during critical situations\n\n### Setting Up TV Mode\n\n1. Create your board with the reports you want to display\n2. Click Preview\n3. Select TV Mode\n\n## Best Practices\n\n### Dashboard Design\n\n- **Keep it focused** - Include only the most important metrics\n- **Use consistent layouts** - Maintain visual hierarchy\n- **Consider your audience** - Tailor content for different stakeholders\n- **Regular updates** - Refresh dashboards as your needs evolve\n\n### Performance Optimization\n\n- **Limit report count** - Too many reports can slow performance\n- **Use appropriate date ranges** - Shorter ranges for better performance\n- **Apply filters** - Reduce data volume for faster loading\n- **Schedule updates** - Set reasonable refresh intervals\n\n## Common Use Cases\n\n### Executive Dashboard\n\n- High-level performance metrics\n- Customer satisfaction scores\n- Volume trends\n- Team productivity indicators\n\n### Operations Dashboard\n\n- Real-time response times\n- Open conversation counts\n- Agent workload distribution\n- SLA compliance metrics\n\n### Team Dashboard\n\n- Individual performance metrics\n- Channel-specific data\n- Quality indicators\n- Improvement opportunities\n\n## Related pages\n\n- [Performance Analytics](https://docs.unthread.io/docs/analytics/performance-analytics)\n- [AI Analytics](https://docs.unthread.io/docs/analytics/ai-analytics)\n- [Volume Analytics](https://docs.unthread.io/docs/analytics/volume-analytics)\n- [Analytics Overview](https://docs.unthread.io/docs/analytics/analytics-overview)\n","2025-09-09T18:48:13.198Z","2026-08-31T19:31:43.827Z","4e75cbc7-b67a-4946-a420-203034aff02d",[],[],[],"Audit Logs","audit-logs","Unthread Audit Logs is an **admin-only** page that captures key account and configuration events. This allows you to understand the who, when, and why of changes in your account.\n\n> **Note**: this feature is only available on the Enterprise plan.\n\n## Events Captured\n\n### Authentication & Access\n\n- Login / logout\n- Portal user registration\n- Portal password reset request\n- User impersonation (dashboard + portal)\n- SSO config changes (enabled/disabled, protocol)\n- Auth method changes (password/Google sign-in toggled)\n- API key created / revoked\n\n### User Management\n\n- User created (name, email, role)\n- User updated (role, name, email, status — role changes flagged as high importance)\n- User deactivated / reactivated\n- User deleted\n\n### Service Accounts\n\n- Service account created / disabled / enabled\n- API key created / revoked\n\n### [Projects](https://docs.unthread.io/docs/setting-up-your-account/projects-permissions)\n\n- Project created / deleted\n- Project settings updated (name, visibility, description, escalation settings, AI features, channel settings, intake settings, autoresponder settings, etc.)\n\n### Automations\n\n- Automation created / deleted\n- Automation updated (name, status, trigger)\n\n### Org / Tenant Settings\n\n- Tenant settings updated (name, support branding, permissions, working hours, AI features, Slack inbox config, integrations, post-close settings, allowed priorities, customer view settings, AI usage limits, allowed email domains, etc.)\n\n## Metadata included with each audit log entry\n\nEvery entry captures (when available):\n\n- Who performed the action (user, automation, or system)\n- Source (Dashboard, API, Slack, Portal, etc.)\n- IP address + geo location (city, region, country)\n- Auth method (session, API key, etc.)\n- Timestamp","2026-04-01T18:26:21.692Z","2026-06-26T18:52:37.932Z","e5d8442f-9d0c-415f-9de5-ab86a23b9790",[],[],[],"Analytics Overview","analytics-overview","## Introduction\n\nWelcome to Unthread Analytics! Whether you’re just getting started or looking to dive deeper, this guide will help you understand and optimize your customer support operations using data.\n\nThink of analytics as your support team’s compass—it shows you where you’ve been, where you are now, and helps you navigate toward better customer experiences.\n\n## Getting Started: Your First Steps\n\n1. **Navigate to Analytics**\n\n Go to **Dashboard > Analytics** in the main menu\n\n2. **Start with Response Times**\n\n Begin with first response time reports to understand your team’s current performance\n\n3. **Save Your First Report**\n\n When you find a view you like, save it as a report for quick access later\n\n4. **Build Your Dashboard**\n\n Use the board builder to combine multiple reports into a comprehensive view\n\n5. **Set Up Regular Reviews**\n\n Schedule time to review your analytics regularly\n\n 🎦 [See AI insights transform ticket analytics in action.](https://www.loom.com/share/8da07b9fe84146759d4860f8265079cc?sid=5e1470a7-35a3-4a3d-b44a-f7b3a9c04d67)\n\n## What You Can Track\n\n### [Performance Analytics](https://docs.unthread.io/docs/analytics/performance-analytics)\n\nSee how quickly your team responds to customers and resolves issues. Track response times, resolution times, and overall team efficiency to spot areas for improvement.\n\n### [Volume Analytics](https://docs.unthread.io/docs/analytics/volume-analytics)\n\nUnderstand your workload patterns and conversation volumes. Identify when you’re busiest and plan your staffing accordingly.\n\n### [AI Analytics](https://docs.unthread.io/docs/analytics/ai-analytics)\n\nSee how well your AI assistant is performing. Track deflection rates and understand how effectively your AI handles customer inquiries.\n\n### [Board Builder](https://docs.unthread.io/docs/analytics/board-builder)\n\nCreate custom dashboards that combine multiple reports. Great for executives and stakeholders who need a high-level view of everything.\n\n## Your Analytics Dashboard\n\n### Real-Time Updates\n\nYour analytics update in real-time, so you’re always looking at current data. No more wondering if your reports are stale—what you see is what’s happening right now!\n\n### Interactive Dashboards\n\nUse the board builder to create custom dashboards that display multiple reports side by side. This is where the magic happens—your personal mission control for monitoring the metrics that matter most to your team.\n\n### Smart Filtering\n\nFilter your data by assignee, customer, channel, priority, status, and custom fields to focus on specific aspects of your support operations.\n\n### Export Your Data\n\nDownload your analytics data as CSV files for external analysis, presentations, or reporting to stakeholders.\n\n### Business Hours Focus\n\nToggle between all hours and business hours to focus on working time metrics—perfect for operational planning and SLA monitoring.\n\n## How Teams Use Analytics\n\n## ![AnalyticsReportType.gif](https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/unthread-unthread-e4pm8%2Fknowledge-base%2FAnalyticsReportType.gif?alt=media)\n\n### Daily Operations: Your Morning Check-in\n\nStart your day by checking your analytics dashboard. Monitor response times and open conversation counts to understand your current workload. Check AI deflection rates and review volume patterns to ensure balanced distribution.\n\n### Weekly Reviews: The Big Picture\n\nSet aside time each week to analyze resolution times and customer satisfaction scores. Review escalation rates and channel performance to identify bottlenecks and celebrate wins.\n\n### Monthly Planning: Strategic Insights\n\nUse monthly analytics reviews to assess overall team performance trends. Review customer satisfaction and sentiment trends to understand long-term patterns.\n\n## \n\n## Getting the Most Out of Analytics\n\n### Start Simple\n\nDon’t try to track everything at once. Begin with 2-3 key metrics that align with your team’s goals, then gradually expand your analysis.\n\n### Set Your Baselines\n\nDocument your current performance levels and set realistic improvement targets. Track your progress over time to measure success.\n\n### Make It a Habit\n\nSchedule regular analytics reviews with your team. Use the data to inform process improvements and recognize achievements.\n\n### Optimize Performance\n\n- Use business hours filtering for operational metrics\n- Limit date ranges for better performance\n- Apply filters early to reduce data volume\n- Save frequently used reports for quick access\n\n## Need Help?\n\nFor technical issues or questions about analytics functionality:\n\n- **In-app Help**: Click on the Unthread icon in the analytics interface\n- **Documentation**: Refer to the detailed guides linked above\n- **Still need assistance?**: Shoot us a note at [hello@unthread.io](mailto:hello@unthread.io) or send us a message in your dedicated Slack channel.\n\n## Related Pages\n\n- [**API Reference**](https://docs.unthread.io/docs/api-docs/api-reference)","2025-09-09T18:48:17.333Z","2026-07-30T19:54:14.714Z","bac5f324-40af-44b9-adbc-8aaafbbbbbd7",[],[],[],"AI Analytics","ai-analytics","## Introduction\n\nNavigate to **Analytics > AI** to view AI performance metrics and understand how your AI assistant is handling customer inquiries.\n\nThis view breaks tickets down by whether agent interaction was needed. For tickets that were deflected, you’ll see a more in-depth grouping.\n\n![ai-deflection-2026-06-04.png](/api/knowledge-base/images/adac55b0-05c0-4edb-a29b-bb998c6cbda8)\n\n## Key metrics: “AI engaged” vs “Deflected conversations”\n\n### AI engaged\n\n**AI engaged** counts conversations where **Unthread AI was engaged** in the conversation.\n\n### Deflected conversations\n\n**Deflected conversations** counts conversations that are **marked as “deflected.”**\n\n### Why the counts can differ\n\nThese counts can differ if your team is **marking tickets as “deflected” via the Unthread API**, even when **Unthread AI is not engaged**. This may happen when an external script/process marks conversations as deflected.\n\n## Deflection Categories\n\nWe’ll highlight the deflection categories below:\n\n- **Closed by Internal User** - The ticket was closed manually by an agent\n- **Closed by Submitter** - The customer closed the ticket themselves after receiving an AI response\n- **Stale Intake** - The user was served a reply by the bot, but there was no explicit indication by the user. This typically indicates that they got the answer that they wanted and then moved on.\n- **Closed by API** - An external script/process you have set up is marking the conversations as deflected\n\n**ℹ️** *AI analytics help you understand your AI assistant’s effectiveness and identify areas where your knowledge base might need improvement.*\n\n## AI Performance Metrics\n\n### Deflection Rate\n\nTrack how often your AI successfully handles inquiries without human intervention. A higher deflection rate means your AI is effectively resolving customer issues independently. The Deflection Rate Percentage is calculated using the number of Deflected Conversation divided by the Total number of conversations during the selected time period.\n\n## AI Generated Response History\n\nHere you’ll find a list of all tickets within a time period (default is 30 days) along with the AI response and any user feedback provided. We intend this list to guide you as an admin to understand where your documentation sources could use some additional context or documents.\n\n### Using the Response History\n\n- **Review AI Responses** - See exactly what your AI assistant is saying to customers\n- **Analyze User Feedback** - Understand which responses received positive or negative feedback\n- **Identify Knowledge Gaps** - Spot areas where your documentation needs improvement\n- **Track Performance Trends** - Monitor how AI effectiveness changes over time\n\n## Related Pages\n\n- [AI Responses](https://docs.unthread.io/docs/unthread-ai/ai-generated-responses)\n- [Analytics Overview](https://docs.unthread.io/docs/analytics/analytics-overview)\n- [Knowledge Base](https://docs.unthread.io/docs/knowledge-base/knowledge-base-setup)","2025-09-09T18:48:12.610Z","2026-08-06T17:41:08.888Z","55b9c5e5-47a6-4514-8c00-bc33f4b161e7",[],[],[],"In-App Support","in-app-support","message-circle","2025-09-09T20:09:11.506Z","2025-10-08T20:23:09.750Z","6ceeb548-f7bc-40ca-80c5-4a09ea9a2206",3,[486,487,488],[],{"_57":507,"_118":508,"_138":-5,"_139":509,"_141":482,"_142":-5,"_143":510,"_145":511,"_22":512,"_24":25,"_120":513,"_150":-5,"_151":514,"_153":515},{"_57":498,"_118":499,"_138":-5,"_139":500,"_141":482,"_142":-5,"_143":501,"_145":502,"_22":503,"_24":25,"_120":504,"_150":-5,"_151":505,"_153":506},{"_57":489,"_118":490,"_138":-5,"_139":491,"_141":482,"_142":-5,"_143":492,"_145":493,"_22":494,"_24":25,"_120":495,"_150":-5,"_151":496,"_153":497},"In-App Chat Support","in-app-chatsupport","![widget-flow.png](/api/knowledge-base/images/7c6dba6e-d784-42d4-a116-b361b7e241ce)\n\nThe in-app chat widget feature allows your customers to get in touch with your support team from your website. The chat widget will appear as a small icon on your website, and when a visitor clicks on it, a chat window will open where they can enter their question or issue. Messages will be posted to Slack and your team will be able to respond in real time directly from the Slack thread.\n\n## How it Works\n\n### Live Chat on Your Site\n\n![website-chat-widget.png](/api/knowledge-base/images/4bdea93f-e242-4bc5-b679-75315149f56d)\n\nWhen embed the in-app chat bubble, your customers have a way to create new [conversations](https://docs.unthread.io/docs/managing-your-inbox/managing-your-inbox-on-the-web) right from your website. You can choose to identify users that are already logged in or ask them to provide a name and email. You can also customize the color and welcome messages to match your brand.\n\n### Creating Slack Thread\n\n![widget-thread.png](/api/knowledge-base/images/dbb076cd-8be6-4b6d-b414-1b2b004b8add)\n\nAll new tickets created from the widget will be posted to an internal thread in Slack. This is where you can easily loop in members of your team. You can also reply directly from the Slack thread by including the “/unthread send” keyword at the end of your message.\n\n### Automations\n\nYou can leverage the existing powerful functionality of Unthread:\n\n- Reply or add internal notes from your inbox\n- Enable [assignment rules and SLAs](https://docs.unthread.io/docs/conversational-ticketing/slas)\n- Set up an [automated response](https://docs.unthread.io/docs/unthread-ai/ai-generated-responses) for all new messages\n- Automatically [apply tags](https://docs.unthread.io/docs/unthread-ai/automatically-tagging-conversations-with-ai) based on question type\n- And more…\n\n### Continuing via Email\n\nIf the user hasn’t read your message within 5 minutes (meaning they may have left the page), then we will automatically send your reply via email. Users can reply to that email to continue the conversation seamlessly.\n\n## Get Started\n\n### Configuring the widget\n\n- Sign in to your Unthread dashboard and **navigate to “Channels” → “In-App Chat”.**\n- On the settings page, you can customize the appearance of the chat widget, including the color and position on your website. You can also customize the greeting message that appears when a user first opens the chat. These settings can be modified later.\n- Select a channel that chat messages will be posted to in Slack.\n- Add assignment and escalation rules.\n- Once you have customized the chat widget to your liking, click on the “Enable” button to generate the code that you will need to add to your website. This will also generate an identity verification secret. See below for how to use this to verify user identities.\n\nℹ️ _✨ Configuration settings can be updated remotely without changing any code on your site!_\n\n### Adding to Your Site\n\n- Copy the auto-generated code and paste it into the HTML of your website. The code should ideally be placed within the `` tag of your website.\n\n- The widget will be hidden by default. In order to show it, you will need to run the following Javascript code somewhere on your website:\n\n ```plaintext\n window.$unthread.inAppChat(\"start\");\n ```\n\n - This code can either be run immediately after the auto-generated snippet or you can wait to run it, for example after the user has logged in.\n\n- If you have a CSP, you’ll want to add `https://YOUR_SUBDOMAIN.unthread.io` to\n\n - script-src\n - connect-src\n - frame-src\n\n- The widget should now be visible and ready for use. By default, new users will be asked to provide their name and email address before they send their first message.\n\n- Optionally, you can pass details about the user when starting up the widget. When starting up the widget, pass a user object in the start call:\n\n ```plaintext\n window.$unthread.inAppChat(\"start\", {\n user: {\n name: \"John Smith\",\n email: \"johnsmith@acme.com\",\n },\n });\n ```\n\n - This will automatically set the name and email of the user. They will not be prompted to enter those fields themselves when they open the widget.\n\n- If you want to clear the chat history when a user logs out, run the following Javascript code on logout:\n\n ```plaintext\n window.$unthread.inAppChat(\"stop\");\n ```\n\n### Verify the Identity of Logged In Users\n\n- For added security, you can also verify that the email address actually belongs to the user. This will require the identity verification secret that was generated on the widget settings page. You will also need to be able to modify the server side code of your website.\n\n- Copy the identity verification secret and put it somewhere secure that is accessible by your website’s server. This secret should never be exposed on the frontend of your website because it can be used to impersonate other users.\n\n- When a user logs into your website, you will use the secret to generate an HMAC of the user’s email address. See below on how to generate the HMAC. The HMAC should be generated on your server and sent to your frontend as part of the login process. The HMAC will be passed as part of the user object passed to the start call.\n\n ```plaintext\n window.$unthread.inAppChat(\"start\", {\n user: {\n name: \"John Smith\",\n email: \"johnsmith@acme.com\",\n verificationHash: \"9l8ugiue98ie9u8ifbmeu897fidhe89u7fi07f\",\n },\n });\n ```\n\n- Never send sensitive information to unverified users.\n\n ### Generating the HMAC verification hash\n\n How you generate the HMAC verification hash depends on what language you use on your server. Here are some examples in different languages: **Javascript (Node.js)**\n\n ```plaintext\n const crypto = require(\"crypto\");\n\n const secret = \"\";\n const email = \"\";\n\n const verificationHash = crypto.createHmac(\"sha256\", secret).update(email).digest(\"hex\");\n ```\n\n **PHP**\n\n ```plaintext\n ';\n $email = '';\n\n $verification_hash = hash_hmac('sha256', $email, $secret);\n ?>\n ```\n\n **Ruby**\n\n ```plaintext\n require 'openssl'\n require 'base64'\n\n secret = ''\n email = ''\n\n OpenSSL::HMAC.hexdigest('sha256', secret, email)\n ```\n\n **Python**\n\n ```plaintext\n import hashlib\n import hmac\n import base64\n\n secret = bytes('', 'utf-8')\n email = bytes('', 'utf-8')\n\n hash = hmac.new(secret, email, hashlib.sha256)\n hash.hexdigest()\n ```\n\n## Using the Unthread SDK\n\nIn addition to `start` and `stop` there are few more functions available in the Unthread SDK: Toggle the visibility of the chat window:\n\n```plaintext\nwindow.$unthread.inAppChat(\"toggle\", \"show\");\nwindow.$unthread.inAppChat(\"toggle\", \"hide\");\n```\n\nToggle the visibility of the message bubble:\n\n```plaintext\nwindow.$unthread.inAppChat(\"toggleBubble\", \"show\");\nwindow.$unthread.inAppChat(\"toggleBubble\", \"hide\");\n```\n\nToggle dark mode:\n\n```plaintext\nwindow.$unthread.inAppChat(\"setDarkMode\", \"dark\");\n```\n\nor\n\n```plaintext\nwindow.$unthread.inAppChat(\"setDarkMode\", \"light\");\n```\n\nLink user to a particular Account:\n\n```plaintext\nwindow.$unthread.inAppChat(\"setAccountId\", \"ACCOUNT_ID_HERE\");\n```\n\n## Sessions and Message History\n\nIf the user has been verified, their full chat history will be available the next time they login to your website. If the user has not been verified, their chat history will only be available within their current chat session. The chat session lasts 1 week from the user’s last activity within the chat. If the user is idle for more than 1 week, their history will be cleared. Additionally, if you call the `stop` function in the SDK or the user clears their cookies, their chat history will also be cleared.\n\nℹ️ _🍪 Speaking of cookies: the widget only uses **first-party cookies**, meaning they cannot track users across different website and are more privacy-centric._\n","2024-01-26T16:43:00.434Z","2026-08-24T14:41:08.678Z","b14c6436-edf4-420e-9a96-17892aee314e",[],[],[],"Embedded Customer Portal","embedded-customer-portal","Embed your Unthread customer portal directly into your own web application so customers never leave your product to get help. The embedded portal supports authenticated access, programmatic navigation, theme customization, and event handling.\n\n## 🔍 How It Works\n\nWhen you embed the portal, a small JavaScript snippet on your page loads the portal inside an invisible `