{"items":[{"type":"link","label":"Fin Custom Helpdesk API","link":"/docs/guides/fin-custom-helpdesk/api","routeSlug":"/docs/guides/fin-custom-helpdesk/api","content":{"contentType":"overview","meta":{"name":"Fin Custom Helpdesk API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/docs/guides/fin-custom-helpdesk/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/docs/guides/fin-custom-helpdesk/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://developers.intercom.com","url":"https://developers.intercom.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"go","title":"Go","lang":"Go"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fin Custom Helpdesk API (0.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Fin Custom Helpdesk API allows you to integrate your custom helpdesk with Fin through a standardized set of API endpoints and webhooks."}],"sectionId":"/docs/guides/fin-custom-helpdesk/api"}],"sectionId":"/docs/guides/fin-custom-helpdesk/api"}]}]}},{"type":"group","label":"Users","link":"/docs/guides/fin-custom-helpdesk/api/users","routeSlug":"/docs/guides/fin-custom-helpdesk/api/users","items":[{"label":"Get User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/users/getuser","routeSlug":"/docs/guides/fin-custom-helpdesk/api/users/getuser","metadata":{"seo":{"title":"Get User","description":"Retrieve an end-user by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Get User","isWebhook":false,"pointer":"/paths/~1user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an end-user by their ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to load an end-user from the customer’s system. We will call this during synchronization to get the latest data about the end-user to drive the Fin workflows and tasks correctly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If using the Fin messenger with a logged in and verified end-user, we will load the end- user when they start a new conversation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"user_id","in":"query","schemaId":"schema_552"}],"pointer":"/paths/~1user/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[{"name":"user_id","in":"query","schemaId":"schema_552"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/user","href":"users/getuser","openApiOperationId":"getUser","summary":"Get User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User found successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EndUser"}},"schemaId":"components/schemas/EndUser"}],"pointer":"/paths/~1user/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EndUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EndUser"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/user"},{"label":"Update User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/users/updateuser","routeSlug":"/docs/guides/fin-custom-helpdesk/api/users/updateuser","metadata":{"seo":{"title":"Update User","description":"Update an end-user by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update User","isWebhook":false,"pointer":"/paths/~1user/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an end-user by their ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_553"}},"schemaId":"schema_553","pointer":"/paths/~1user/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/user","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_553"}},"responseCodes":["200"],"pointer":"/user","href":"users/updateuser","openApiOperationId":"updateUser","summary":"Update User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"schemaId":"schema_553","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_553"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EndUser"}},"schemaId":"components/schemas/EndUser"}],"pointer":"/paths/~1user/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EndUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EndUser"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuser"}],"panels":[]}]},"httpPath":"/user"},{"label":"Create User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/users/createuser","routeSlug":"/docs/guides/fin-custom-helpdesk/api/users/createuser","metadata":{"seo":{"title":"Create User","description":"When an end-user starts a conversation in the Fin Messenger and there is no information about them in the third party we request a new record be created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create User","isWebhook":false,"pointer":"/paths/~1user/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"When an end-user starts a conversation in the Fin Messenger and there is no information about them in the third party we request a new record be created.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554","pointer":"/paths/~1user/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_554"}},"responseCodes":["201"],"pointer":"/user","href":"users/createuser","openApiOperationId":"createUser","summary":"Create User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_554"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"End-user created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EndUser"}},"schemaId":"components/schemas/EndUser"}],"pointer":"/paths/~1user/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/EndUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EndUser"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createuser"}],"panels":[]}]},"httpPath":"/user"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Manage end-users in your helpdesk system"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/user","summary":"Get User","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/user","summary":"Update User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/updateuser","deprecated":false},{"title":"/user","summary":"Create User","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/createuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Agents","link":"/docs/guides/fin-custom-helpdesk/api/agents","routeSlug":"/docs/guides/fin-custom-helpdesk/api/agents","items":[{"label":"Get Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/agents/getagents","routeSlug":"/docs/guides/fin-custom-helpdesk/api/agents/getagents","metadata":{"seo":{"title":"Get Agents","description":"The customer must choose an Agent from within their own system to act as Fin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgents","name":"Get Agents","isWebhook":false,"pointer":"/paths/~1agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The customer must choose an Agent from within their own system to act as Fin.\n\nWhen we tell the customer about responses from Fin, the author ID will be the agent chosen to act as Fin.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agents","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/agents","href":"agents/getagents","openApiOperationId":"getAgents","summary":"Get Agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Agents retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_555","exampleIds":["paths/~1agents/get/responses/200/content/application~1json/examples/example1"]}},"schemaId":"schema_555","exampleIds":["paths/~1agents/get/responses/200/content/application~1json/examples/example1"]}],"pointer":"/paths/~1agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_555","exampleIds":["paths/~1agents/get/responses/200/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_555","exampleIds":["paths/~1agents/get/responses/200/content/application~1json/examples/example1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/getagents"}],"panels":[]}]},"httpPath":"/agents"}],"content":{"contentType":"group","meta":{"name":"Agents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agents","showPageActions":true},{"nodeType":"markdoc","content":"Manage agents in your helpdesk system"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/agents","summary":"Get Agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agents/getagents","deprecated":false}]}]}]}]}},{"type":"group","label":"Conversations","link":"/docs/guides/fin-custom-helpdesk/api/conversations","routeSlug":"/docs/guides/fin-custom-helpdesk/api/conversations","items":[{"label":"Get Conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/conversations/getconversation","routeSlug":"/docs/guides/fin-custom-helpdesk/api/conversations/getconversation","metadata":{"seo":{"title":"Get Conversation","description":"Used to load a known conversation from the customer's system. Used during ongoing synchronizations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversation","name":"Get Conversation","isWebhook":false,"pointer":"/paths/~1conversation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Used to load a known conversation from the customer's system. Used during ongoing synchronizations.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"conversation_id","in":"query","schemaId":"schema_552"}],"pointer":"/paths/~1conversation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversation","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[{"name":"conversation_id","in":"query","schemaId":"schema_552"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/conversation","href":"conversations/getconversation","openApiOperationId":"getConversation","summary":"Get Conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conversation found successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conversation"}},"schemaId":"components/schemas/Conversation"}],"pointer":"/paths/~1conversation/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Conversation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conversation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversation"}],"panels":[]}]},"httpPath":"/conversation"},{"label":"Update Conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/conversations/updateconversation","routeSlug":"/docs/guides/fin-custom-helpdesk/api/conversations/updateconversation","metadata":{"seo":{"title":"Update Conversation","description":"Called at the end of a synchronization run to push the latest derived data into the Customer’s system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConversation","name":"Update Conversation","isWebhook":false,"pointer":"/paths/~1conversation/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Called at the end of a synchronization run to push the latest derived data into the Customer’s system."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_556"}},"schemaId":"schema_556","pointer":"/paths/~1conversation/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/conversation","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_556"}},"responseCodes":["200"],"pointer":"/conversation","href":"conversations/updateconversation","openApiOperationId":"updateConversation","summary":"Update Conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"schemaId":"schema_556","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_556"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conversation updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conversation"}},"schemaId":"components/schemas/Conversation"}],"pointer":"/paths/~1conversation/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Conversation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conversation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/updateconversation"}],"panels":[]}]},"httpPath":"/conversation"},{"label":"Create Conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/conversations/createconversation","routeSlug":"/docs/guides/fin-custom-helpdesk/api/conversations/createconversation","metadata":{"seo":{"title":"Create Conversation","description":"Called when a new conversation has been created via the Fin Messenger. Note we provide the initial message from the conversation as we know many help desks require this to be provided when creating a conversation. The response requires both the conversation object and the message object so that these can be mapped correctly to their Fin equivalents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConversation","name":"Create Conversation","isWebhook":false,"pointer":"/paths/~1conversation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Called when a new conversation has been created via the Fin Messenger.\nNote we provide the initial message from the conversation as we know many help desks require this to be provided when creating a conversation.\nThe response requires both the conversation object and the message object so that these can be mapped correctly to their Fin equivalents.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_557"}},"schemaId":"schema_557","pointer":"/paths/~1conversation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversation","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_557"}},"responseCodes":["201"],"pointer":"/conversation","href":"conversations/createconversation","openApiOperationId":"createConversation","summary":"Create Conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"schemaId":"schema_557","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_557"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Conversation created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_558"}},"schemaId":"schema_558"}],"pointer":"/paths/~1conversation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_558","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_558"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/createconversation"}],"panels":[]}]},"httpPath":"/conversation"}],"content":{"contentType":"group","meta":{"name":"Conversations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversations","showPageActions":true},{"nodeType":"markdoc","content":"Manage conversations between end-users and agents"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/conversation","summary":"Get Conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversation","deprecated":false},{"title":"/conversation","summary":"Update Conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/updateconversation","deprecated":false},{"title":"/conversation","summary":"Create Conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/createconversation","deprecated":false}]}]}]}]}},{"type":"group","label":"Messages","link":"/docs/guides/fin-custom-helpdesk/api/messages","routeSlug":"/docs/guides/fin-custom-helpdesk/api/messages","items":[{"label":"Get Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/messages/getmessages","routeSlug":"/docs/guides/fin-custom-helpdesk/api/messages/getmessages","metadata":{"seo":{"title":"Get Messages","description":"Called during synchronization to pull in the messages from the conversation in your system.Messages which have already been synchronized will be ignored. New messages will be pulled into Fin’s version of the Conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMessages","name":"Get Messages","isWebhook":false,"pointer":"/paths/~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Called during synchronization to pull in the messages from the conversation in your system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages which have already been synchronized will be ignored. New messages will be pulled into Fin’s version of the Conversation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"conversation_id","in":"query","schemaId":"schema_552","description":"The ID of the conversation in your system."},{"name":"after_id","in":"query","schemaId":"schema_552","description":"ID of the last seen message ID from the external system. As an optimization, the external service may choose to return only messages created after this."}],"pointer":"/paths/~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/messages","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[{"name":"conversation_id","in":"query","schemaId":"schema_552"},{"name":"after_id","in":"query","schemaId":"schema_552"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/messages","href":"messages/getmessages","openApiOperationId":"getMessages","summary":"Get Messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Messages retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559","exampleIds":["paths/~1messages/get/responses/200/content/application~1json/examples/example1"]}},"schemaId":"schema_559","exampleIds":["paths/~1messages/get/responses/200/content/application~1json/examples/example1"]}],"pointer":"/paths/~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","exampleIds":["paths/~1messages/get/responses/200/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559","exampleIds":["paths/~1messages/get/responses/200/content/application~1json/examples/example1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/getmessages"}],"panels":[]}]},"httpPath":"/messages"},{"label":"Create Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/messages/createmessage","routeSlug":"/docs/guides/fin-custom-helpdesk/api/messages/createmessage","metadata":{"seo":{"title":"Create Message","description":"Used during synchronization to push new messages into your helpdesk. These messages may come from either the end-user or Fin. Note that the author of the Fin messages will be the agent selected to represent Fin on initial setup of the integration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMessage","name":"Create Message","isWebhook":false,"pointer":"/paths/~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Used during synchronization to push new messages into your helpdesk. These messages may come from either the end-user or Fin.\nNote that the author of the Fin messages will be the agent selected to represent Fin on initial setup of the integration.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"oauth2","description":"OAuth2 access token configured in Fin Deployment UI","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560","pointer":"/paths/~1messages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/messages","servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://helpdesk.fin.com/api/auth/oauth/token","scopes":{"read":"Read access to the API (example)","write":"Write access to the API (example)"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_560"}},"responseCodes":["201"],"pointer":"/messages","href":"messages/createmessage","openApiOperationId":"createMessage","summary":"Create Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://helpdesk.example.com/api/fin","description":"Your Custom Helpdesk API (replace with your actual domain)"}],"schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_560"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Message created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Message"}},"schemaId":"components/schemas/Message"}],"pointer":"/paths/~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Message","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Message"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/createmessage"}],"panels":[]}]},"httpPath":"/messages"}],"content":{"contentType":"group","meta":{"name":"Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Messages","showPageActions":true},{"nodeType":"markdoc","content":"Manage messages within conversations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/messages","summary":"Get Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/getmessages","deprecated":false},{"title":"/messages","summary":"Create Message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/createmessage","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/docs/guides/fin-custom-helpdesk/api/webhooks","routeSlug":"/docs/guides/fin-custom-helpdesk/api/webhooks","items":[{"label":"Notify Fin of Conversation Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/guides/fin-custom-helpdesk/api/webhooks/customhelpdeskconversationevent","routeSlug":"/docs/guides/fin-custom-helpdesk/api/webhooks/customhelpdeskconversationevent","metadata":{"seo":{"title":"Notify Fin of Conversation Events","description":"This endpoint handles two distinct use cases depending on whether an event_type is provided:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customHelpdeskConversationEvent","name":"Notify Fin of Conversation Events","isWebhook":false,"pointer":"/paths/~1custom_helpdesk_conversation_event~1{integration_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notify Fin of Conversation Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint handles two distinct use cases depending on whether an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/customhelpdeskconversationevent/request/1.-conversation-synchronization-(default-behavior)","deepLinkHash":"/webhooks/customhelpdeskconversationevent#webhooks/customhelpdeskconversationevent/request/1.-conversation-synchronization-(default-behavior)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Conversation Synchronization (default behavior)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omit the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Fin will synchronize the conversation by pulling the latest data from your endpoints. Use this when:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An agent sends a message"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversation state changes (status, assignee, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any other conversation data changes that Fin should know about"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example payload:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"conversation_id\": \"conv_456\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"conversation_id\": \"conv_456\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/customhelpdeskconversationevent/request/2.-agent-typing-indicator","deepLinkHash":"/webhooks/customhelpdeskconversationevent#webhooks/customhelpdeskconversationevent/request/2.-agent-typing-indicator"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Agent Typing Indicator"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_typing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Fin will display a typing indicator to the end-user in the Fin Messenger. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No synchronization occurs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this is purely a real-time UI update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this when an agent starts typing a response in your helpdesk. The typing indicator automatically dismisses after a few seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type: \"agent_typing\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must include the agent's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example payload:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"conversation_id\": \"conv_456\",\n \"event_type\": \"agent_typing\",\n \"data\": {\n \"agent\": {\n \"id\": \"agent_001\",\n \"user_type\": \"agent\",\n \"name\": \"Sarah Johnson\",\n \"email\": \"sarah.johnson@company.com\"\n }\n }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"conversation_id\": \"conv_456\",\n \"event_type\": \"agent_typing\",\n \"data\": {\n \"agent\": {\n \"id\": \"agent_001\",\n \"user_type\": \"agent\",\n \"name\": \"Sarah Johnson\",\n \"email\": \"sarah.johnson@company.com\"\n }\n }\n}\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"WebhookSignature","scopes":[],"type":"apiKey","in":"header","paramName":"X-Webhook-Key","description":"Webhook key for the custom helpdesk integration. Obtained from Fin Deployment UI.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"integration_id","in":"path","schemaId":"schema_552","description":"The ID of your integration. You can find this in the Fin Deployment UI.","required":true,"example":"a3c729d4e8f6b15c"}],"pointer":"/paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_561","exampleIds":["paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/conversation_sync","paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/agent_typing"]}},"schemaId":"schema_561","exampleIds":["paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/conversation_sync","paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/agent_typing"],"pointer":"/paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_helpdesk_conversation_event/{integration_id}","servers":[{"url":"https://api.intercom.io/hooks/standalone","description":"Fin Webhook US Endpoint"},{"url":"https://api.eu.intercom.io/hooks/standalone","description":"Fin Webhook EU Endpoint"},{"url":"https://api.au.intercom.io/hooks/standalone","description":"Fin Webhook AU Endpoint"}],"parameters":{"path":[{"name":"integration_id","in":"path","required":true,"example":"a3c729d4e8f6b15c","schemaId":"schema_552"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"WebhookSignature","type":"apiKey","name":"X-Webhook-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_561","exampleIds":["paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/conversation_sync","paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/agent_typing"]}},"responseCodes":["204","400","401","404"],"pointer":"/custom_helpdesk_conversation_event/{integration_id}","href":"webhooks/customhelpdeskconversationevent","openApiOperationId":"customHelpdeskConversationEvent","summary":"Notify Fin of Conversation Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io/hooks/standalone","description":"Fin Webhook US Endpoint"},{"url":"https://api.eu.intercom.io/hooks/standalone","description":"Fin Webhook EU Endpoint"},{"url":"https://api.au.intercom.io/hooks/standalone","description":"Fin Webhook AU Endpoint"}],"schemaId":"schema_561","exampleIds":["paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/conversation_sync","paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/agent_typing"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_561","exampleIds":["paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/conversation_sync","paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/requestBody/content/application~1json/examples/agent_typing"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Webhook accepted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid payload. Common causes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_typing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing required fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}]},{"code":"401","description":"Invalid or missing signature"},{"code":"404","description":"Custom helpdesk integration not found"}],"pointer":"/paths/~1custom_helpdesk_conversation_event~1{integration_id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/customhelpdeskconversationevent"}],"panels":[]}]},"httpPath":"/custom_helpdesk_conversation_event/{integration_id}"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Notify Fin when conversations change"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_helpdesk_conversation_event/{integration_id}","summary":"Notify Fin of Conversation Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/customhelpdeskconversationevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Models","link":"/docs/guides/fin-custom-helpdesk/api/models","routeSlug":"/docs/guides/fin-custom-helpdesk/api/models","items":[{"type":"link","label":"Agent","link":"/docs/guides/fin-custom-helpdesk/api/models/agent","routeSlug":"/docs/guides/fin-custom-helpdesk/api/models/agent","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Agent"},"seo":{"title":"Agent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agent","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Agent"},"children":[]}]}]}},{"type":"link","label":"Attachment","link":"/docs/guides/fin-custom-helpdesk/api/models/attachment","routeSlug":"/docs/guides/fin-custom-helpdesk/api/models/attachment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Attachment"},"seo":{"title":"Attachment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Attachment"},"children":[]}]}]}},{"type":"link","label":"Conversation","link":"/docs/guides/fin-custom-helpdesk/api/models/conversation","routeSlug":"/docs/guides/fin-custom-helpdesk/api/models/conversation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Conversation"},"seo":{"title":"Conversation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Conversation"},"children":[]}]}]}},{"type":"link","label":"EndUser","link":"/docs/guides/fin-custom-helpdesk/api/models/enduser","routeSlug":"/docs/guides/fin-custom-helpdesk/api/models/enduser","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"EndUser"},"seo":{"title":"EndUser"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EndUser","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/EndUser"},"children":[]}]}]}},{"type":"link","label":"Message","link":"/docs/guides/fin-custom-helpdesk/api/models/message","routeSlug":"/docs/guides/fin-custom-helpdesk/api/models/message","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Message"},"seo":{"title":"Message"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Message","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Message"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Models"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Models","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Agent","link":"/models/agent","deprecated":false},{"title":"Attachment","link":"/models/attachment","deprecated":false},{"title":"Conversation","link":"/models/conversation","deprecated":false},{"title":"EndUser","link":"/models/enduser","deprecated":false},{"title":"Message","link":"/models/message","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/EndUser":{"id":"components/schemas/EndUser","kind":"json-schema","title":"EndUser","data":{"type":"object","description":"End user having a conversation with Fin or with an agent.\n","required":["id","user_type"],"properties":{"id":{"type":"string","description":"Unique identifier for the user in your system","example":"user_123456","nullable":false},"user_type":{"type":"string","description":"Type of user","enum":["end_user"],"nullable":false},"name":{"type":"string","description":"User's display name","example":"Jane Doe","nullable":true},"email":{"type":"string","format":"email","description":"User's email address","example":"jane.doe@example.com","nullable":true},"photo_url":{"type":"string","format":"uri","description":"URL to user's avatar/profile picture (displayed in Fin Messenger)","example":"https://example.com/avatars/jane.jpg","nullable":true},"attributes":{"type":"object","description":"Attributes associated with the end-user","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time","description":"ISO 8601 timestamp","example":"2025-10-27T14:30:00.000Z"}]},"example":{"plan_type":"enterprise","signup_date":"2024-01-15","is_premium":true},"nullable":true}}}},"components/schemas/Agent":{"id":"components/schemas/Agent","kind":"json-schema","title":"Agent","data":{"type":"object","description":"Agent having a conversation with an end-user.\n","properties":{"id":{"type":"string","description":"Unique identifier for the user in your system","example":"agent_123456"},"user_type":{"type":"string","description":"Type of user","enum":["agent"]},"name":{"type":"string","description":"User's display name","example":"Jane Doe","nullable":true},"email":{"type":"string","format":"email","description":"User's email address","example":"jane.doe@example.com","nullable":true},"photo_url":{"type":"string","format":"uri","description":"URL to user's avatar/profile picture (displayed in Fin Messenger)","example":"https://example.com/avatars/jane.jpg","nullable":true},"alias":{"type":"string","description":"Agent's display alias (shown to end-users instead of real name)","example":"Support Jane","nullable":true}}}},"components/schemas/Conversation":{"id":"components/schemas/Conversation","kind":"json-schema","title":"Conversation","data":{"type":"object","required":["id","status","user","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the conversation in your system","example":"conv_456"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current conversation status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Conversation is actively ongoing with the end-user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Conversation is resolved by Fin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Conversation is finished/archived"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Conversation is ended by the end-user or agent"},"children":[]}]}]}]}],"enum":["open","resolved","closed","ended"]},"user":{"$ref":"#/components/schemas/EndUser"},"title":{"type":"string","description":"Conversation title or subject","example":"Question about pricing plans","nullable":true},"tags":{"type":"array","description":"List of tags associated with the conversation in your system. Can be used to power routing within the Fin workflow among other things.","items":{"type":"string"},"example":["pricing","sales"],"nullable":true},"attributes":{"type":"object","description":"Attributes associated with the conversation","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"example":{"issue_type":"Billing","priority":"High"}},"assignee":{"$ref":"#/components/schemas/Agent","nullable":true,"description":"Currently assigned agent (null if unassigned) in your system. Fin typically does not attempt to handle conversations assigned to a human agent. If your system allows for multiple agents to be assigned to a conversation you may choose to return any one of these agents."},"created_at":{"type":"string","format":"date-time","description":"When the conversation was created (ISO 8601 UTC)","example":"2025-10-27T14:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","description":"When the conversation was last updated (ISO 8601 UTC)","example":"2025-10-27T15:45:00.000Z"}}}},"components/schemas/Message":{"id":"components/schemas/Message","kind":"json-schema","title":"Message","data":{"type":"object","required":["id","conversation_id","message_type","body","author","visibility","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the message in your system","example":"msg_001"},"conversation_id":{"type":"string","description":"ID of the parent conversation","example":"conv_456"},"message_type":{"type":"string","description":"Type of message","enum":["comment"]},"body":{"type":"string","description":"Message content in HTML format","example":"

Thank you for reaching out! I'd be happy to explain our pricing plans.

"},"author":{"oneOf":[{"$ref":"#/components/schemas/EndUser"},{"$ref":"#/components/schemas/Agent"}],"description":"The user who authored the message."},"visibility":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who can see the message:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Visible to end-users (appears in Fin Messenger)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only visible to agents (internal notes)"},"children":[]}]}]}]}],"enum":["public","private"],"example":"public"},"created_at":{"type":"string","format":"date-time","description":"When the message was created (ISO 8601 UTC)","example":"2025-10-27T14:35:00.000Z"},"attachments":{"type":"array","description":"Files attached to the message","items":{"$ref":"#/components/schemas/Attachment"}}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL where the attachment can be accessed.\nMust be HTTPS. Consider using signed URLs with expiration for sensitive files.\n","example":"https://example.com/files/pricing-guide.pdf"},"filetype":{"type":"string","description":"File type/extension.\n","example":"pdf"},"filename":{"type":"string","description":"Display name for the file","example":"Pricing Guide 2025"}}}},"schema_552":{"kind":"json-schema","data":{"type":"string"},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"type":"object","properties":{"user_id":{"type":"string","description":"ID of the end-user in your system","example":"user_123"},"attributes":{"type":"object","description":"Attributes associated with the end-user","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time","description":"ISO 8601 timestamp","example":"2025-10-27T14:30:00.000Z"}]},"example":{"plan_type":"enterprise","signup_date":"2024-01-15","is_premium":true}}}},"id":"schema_553"},"schema_554":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"User's name (may not be known at creation time)","example":"Jane Doe","nullable":true},"email":{"type":"string","format":"email","description":"User's email (may not be known at creation time)","example":"jane.doe@example.com","nullable":true},"object_id":{"type":"string","description":"Unique identifier for the user in our system","example":"123456"}}},"id":"schema_554"},"schema_555":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"id":"schema_555"},"schema_556":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"ID of the conversation to update","example":"conv_456"},"title":{"type":"string","description":"Conversation title","example":"Pricing inquiry - resolved","nullable":true},"tags":{"type":"array","description":"List of tags associated with the conversation in your system. Can be used to power routing within the Fin workflow among other things.","items":{"type":"string"},"example":["pricing","sales"]},"attributes":{"type":"object","description":"Attributes associated with the conversation","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"example":{"issue_type":"Billing","priority":"High"}},"status":{"type":"string","description":"Conversation status","enum":["open","resolved","closed","ended"],"example":"resolved"},"assignee_id":{"type":"string","description":"Agent ID (Fin agent). Set to null when handing over to a human agent.","example":"agent_fin"},"last_user_read_at":{"type":"string","format":"date-time","description":"When user last read the conversation","example":"2025-10-27T15:45:00.000Z","nullable":true}}},"id":"schema_556"},"schema_557":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","description":"Conversation title (may be blank)","example":"Question about pricing","nullable":true},"user_id":{"type":"string","description":"ID of the end-user in your system","example":"user_123"},"object_id":{"type":"string","description":"Unique identifier for the conversation in our system","example":"123456"},"initial_message":{"type":"object","properties":{"conversation_id":{"type":"string","description":"ID of the parent conversation","example":"conv_456"},"message_type":{"type":"string","description":"Type of message","enum":["comment"]},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message content in HTML format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported HTML tags are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paragraphs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"

"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Heading 1, Heading 2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"

"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"

"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (note h3 to h6 appears as a h2)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bold "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Italic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (can be linked)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line breaks "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"
"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code blocks "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unordered lists "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"