helpscout: appmixer.helpscout.core.GetConversation

Basic Information

Name

appmixer.helpscout.core.GetConversation

Version

1.0.0

Visibility

Public

Description

Retrieve a specific conversation by ID.

Input Ports

in

Field	Type	Description
Conversation ID	text	Conversation ID.

Output Ports

out

Field	Type	Description
Conversation ID		-
Number		-
Threads		-
Type		-
Folder Id		-
Status		-
State		-
Subject		-
Preview		-
Mailbox ID		-
Assignee		-
Created By		-
Created At		-
Closed By		-
Closed By User		-
Closed At		-
User Updated At		-
Customer Waiting Since		-
Source		-
Tags		-
Cc		-
Bcc		-
Primary Customer		-
Snooze		-
Next Event		-
Custom Fields		-
Embedded		-
Links		-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.helpscout.core.GetConversation", "author": "Appmixer <info@appmixer.com>", "description": "Retrieve a specific conversation by ID.", "version": "1.0.0", "private": false, "auth": { "service": "appmixer:helpscout" }, "quota": { "manager": "appmixer:helpscout", "resources": "requests" }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "inspector": { "inputs": { "id": { "type": "text", "tooltip": "Conversation ID.", "label": "Conversation ID", "index": 0 } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Conversation ID", "value": "id", "schema": { "type": "number", "example": 12345 } }, { "label": "Number", "value": "number", "schema": { "type": "number", "example": 1001 } }, { "label": "Threads", "value": "threads", "schema": { "type": "number", "example": 3 } }, { "label": "Type", "value": "type", "schema": { "type": "string", "example": "email" } }, { "label": "Folder Id", "value": "folderId", "schema": { "type": "number", "example": 12345 } }, { "label": "Status", "value": "status", "schema": { "type": "string", "example": "active" } }, { "label": "State", "value": "state", "schema": { "type": "string", "example": "published" } }, { "label": "Subject", "value": "subject", "schema": { "type": "string", "example": "Inquiry about your services" } }, { "label": "Preview", "value": "preview", "schema": { "type": "string", "example": "Hello, I am writing to ask about..." } }, { "label": "Mailbox ID", "value": "mailboxId", "schema": { "type": "number", "example": 12345 } }, { "label": "Assignee", "value": "assignee", "schema": { "type": "object", "properties": { "id": { "type": "number", "title": "Assignee.ID", "example": 12345 }, "type": { "type": "string", "title": "Assignee.Type", "example": "user" }, "first": { "type": "string", "title": "Assignee.First", "example": "John" }, "last": { "type": "string", "title": "Assignee.Last", "example": "Doe" }, "email": { "type": "string", "title": "Assignee.Email", "example": "john.doe@example.com" } } } }, { "label": "Created By", "value": "createdBy", "schema": { "type": "object", "properties": { "id": { "type": "number", "title": "Created By.ID", "example": 12345 }, "type": { "type": "string", "title": "Created By.Type", "example": "user" }, "email": { "type": "string", "title": "Created By.Email", "example": "john.doe@example.com" } } } }, { "label": "Created At", "value": "createdAt", "schema": { "type": "string", "example": "2024-01-15T10:30:00Z" } }, { "label": "Closed By", "value": "closedBy", "schema": { "type": "number", "example": 67890 } }, { "label": "Closed By User", "value": "closedByUser", "schema": { "type": "object", "properties": { "id": { "type": "number", "title": "Closed By User.ID", "example": 12345 }, "type": { "type": "string", "title": "Closed By User.Type", "example": "user" }, "first": { "type": "string", "title": "Closed By User.First", "example": "John" }, "last": { "type": "string", "title": "Closed By User.Last", "example": "Doe" }, "photoUrl": { "type": "string", "title": "Closed By User.Photo Url", "example": "https://example.com/photos/user123.jpg" }, "email": { "type": "string", "title": "Closed By User.Email", "example": "john.doe@example.com" } } } }, { "label": "Closed At", "value": "closedAt", "schema": { "type": "string", "example": "2024-01-17T09:00:00Z" } }, { "label": "User Updated At", "value": "userUpdatedAt", "schema": { "type": "string", "example": "2024-01-16T14:20:00Z" } }, { "label": "Customer Waiting Since", "value": "customerWaitingSince", "schema": { "type": "object", "properties": { "time": { "type": "string", "title": "Customer Waiting Since.Time", "example": "2024-01-15T10:30:00Z" }, "friendly": { "type": "string", "title": "Customer Waiting Since.Friendly", "example": "3 hours ago" } } } }, { "label": "Source", "value": "source", "schema": { "type": "object", "properties": { "type": { "type": "string", "title": "Source.Type", "example": "email" }, "via": { "type": "string", "title": "Source.Via", "example": "customer" } } } }, { "label": "Tags", "value": "tags", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Tags.ID", "example": 12345 }, "color": { "type": "string", "title": "Tags.Color", "example": "blue" }, "tag": { "type": "string", "title": "Tags.Tag", "example": "important" } } } } }, { "label": "Cc", "value": "cc", "schema": { "type": "array", "items": { "type": "string" } } }, { "label": "Bcc", "value": "bcc", "schema": { "type": "array", "items": { "type": "string" } } }, { "label": "Primary Customer", "value": "primaryCustomer", "schema": { "type": "object", "properties": { "id": { "type": "number", "title": "Primary Customer.Id", "example": 12345 }, "type": { "type": "string", "title": "Primary Customer.Type", "example": "user" }, "first": { "type": "string", "title": "Primary Customer.First", "example": "John" }, "last": { "type": "string", "title": "Primary Customer.Last", "example": "Doe" }, "email": { "type": "string", "title": "Primary Customer.Email", "example": "john.doe@example.com" } } } }, { "label": "Snooze", "value": "snooze", "schema": { "type": "object", "properties": { "snoozedBy": { "type": "number", "title": "Snooze.Snoozed By", "example": 12345 }, "snoozedUntil": { "type": "string", "title": "Snooze.Snoozed Until", "example": "2024-01-15T10:00:00Z" }, "unsnoozeOnCustomerReply": { "type": "boolean", "title": "Snooze.Unsnooze On Customer Reply", "example": true } } } }, { "label": "Next Event", "value": "nextEvent", "schema": { "type": "object", "properties": { "time": { "type": "string", "title": "Next Event.Time", "example": "2024-01-15T10:30:00Z" }, "eventType": { "type": "string", "title": "Next Event.Event Type", "example": "snooze" }, "userId": { "type": "number", "title": "Next Event.User Id", "example": 67890 }, "cancelOnCustomerReply": { "type": "boolean", "title": "Next Event.Cancel On Customer Reply", "example": true } } } }, { "label": "Custom Fields", "value": "customFields", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "title": "Custom Fields.Id", "example": 12345 }, "name": { "type": "string", "title": "Custom Fields.Name", "example": "John Doe" }, "value": { "type": "string", "title": "Custom Fields.Value", "example": "custom-value" }, "text": { "type": "string", "title": "Custom Fields.Text", "example": "Custom field text" } }, "required": [ "id", "name", "value", "text" ] } } }, { "label": "Embedded", "value": "_embedded", "schema": { "type": "object", "properties": { "threads": { "type": "array", "items": {}, "title": "Embedded.Threads" } } } }, { "label": "Links", "value": "_links", "schema": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Self.Href", "example": "https://api.example.com/resource/123" } }, "title": "Links.Self" }, "mailbox": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Mailbox.Href", "example": "https://api.example.com/mailboxes/456" } }, "title": "Links.Mailbox" }, "primaryCustomer": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Primary Customer.Href", "example": "https://api.example.com/customers/789" } }, "title": "Links.Primary Customer" }, "createdByCustomer": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Created By Customer.Href", "example": "https://api.example.com/customers/790" } }, "title": "Links.Created By Customer" }, "closedBy": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Closed By.Href", "example": "https://api.example.com/users/101" } }, "title": "Links.Closed By" }, "threads": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Threads.Href", "example": "https://api.example.com/conversations/123/threads" } }, "title": "Links.Threads" }, "assignee": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Assignee.Href", "example": "https://api.example.com/users/102" } }, "title": "Links.Assignee" }, "web": { "type": "object", "properties": { "href": { "type": "string", "title": "Links.Web.Href", "example": "https://app.example.com/conversations/123" } }, "title": "Links.Web" } } } } ] } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCEtLSBVcGxvYWRlZCB0bzogU1ZHIFJlcG8sIHd3dy5zdmdyZXBvLmNvbSwgR2VuZXJhdG9yOiBTVkcgUmVwbyBNaXhlciBUb29scyAtLT4KPHN2ZyB3aWR0aD0iODAwcHgiIGhlaWdodD0iODAwcHgiIHZpZXdCb3g9Ii0yNyAwIDMxMCAzMTAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQiPgogICAgPGc+CiAgICAgICAgPHBhdGggZD0iTTE4LjQzMiwxODAuOTY4NzI3IEwxMDguOTE2MzY0LDkwLjQ4NDM2MzYgQzEyMC42NDU4MTgsNzguOTQxMDkwOSAxMjcuOTA2OTA5LDYyLjc0MzI3MjcgMTI3LjkwNjkwOSw0NS4wNTYgQzEyNy45MDY5MDksMjcuNTU0OTA5MSAxMjAuODMyLDExLjU0MzI3MjcgMTA5LjQ3NDkwOSwwIEwxOC45OTA1NDU1LDkwLjQ4NDM2MzYgQzcuMjYxMDkwOTEsMTAyLjAyNzYzNiAwLDExOC4yMjU0NTUgMCwxMzUuOTEyNzI3IEMwLDE1My42IDcuMDc0OTA5MDksMTY5LjQyNTQ1NSAxOC40MzIsMTgwLjk2ODcyNyBaIE0yMzcuNTY4LDEyOC4wOTMwOTEgTDE0Ny4wODM2MzYsMjE4LjU3NzQ1NSBDMTM1LjM1NDE4MiwyMzAuMTIwNzI3IDEyOC4wOTMwOTEsMjQ2LjMxODU0NSAxMjguMDkzMDkxLDI2NC4wMDU4MTggQzEyOC4wOTMwOTEsMjgxLjUwNjkwOSAxMzUuMTY4LDI5Ny41MTg1NDUgMTQ2LjUyNTA5MSwzMDkuMDYxODE4IEwyMzcuMDA5NDU1LDIxOC41Nzc0NTUgQzI0OC43Mzg5MDksMjA3LjAzNDE4MiAyNTYsMTkwLjgzNjM2NCAyNTYsMTczLjE0OTA5MSBDMjU2LDE1NS40NjE4MTggMjQ4LjkyNTA5MSwxMzkuNjM2MzY0IDIzNy41NjgsMTI4LjA5MzA5MSBaIE0yMzcuMDA5NDU1LDkwLjY3MDU0NTUgQzI0OC43Mzg5MDksNzkuMTI3MjcyNyAyNTYsNjIuOTI5NDU0NSAyNTYsNDUuMjQyMTgxOCBDMjU2LDI3Ljc0MTA5MDkgMjQ4LjkyNTA5MSwxMS43Mjk0NTQ1IDIzNy41NjgsMC4xODYxODE4MTggTDE4Ljk5MDU0NTUsMjE4LjU3NzQ1NSBDNy4yNjEwOTA5MSwyMzAuMzA2OTA5IDAsMjQ2LjMxODU0NSAwLDI2NC4xOTIgQzAsMjgxLjY5MzA5MSA3LjA3NDkwOTA5LDI5Ny43MDQ3MjcgMTguNDMyLDMwOS4yNDggTDIzNy4wMDk0NTUsOTAuNjcwNTQ1NSBaIiBmaWxsPSIjMTI5MkVFIj4KDTwvcGF0aD4KICAgIDwvZz4KPC9zdmc+" }