helpscout: appmixer.helpscout.core.FindConversations

Basic Information

Name

appmixer.helpscout.core.FindConversations

Version

1.0.0

Visibility

Public

Description

Search/list conversations using an advanced Help Scout query. Results are always sorted by modifiedAt in descending order (newest modified first).

Input Ports

in

Field	Type	Description
Query	textarea	Advanced Helpscout customer query. Example: `(subject:"have a question" AND tag:"billing")`. See the docs for the full query syntax.
Status	select	Filter conversations by status.
Output Type	select	Choose how results are returned: first item only, all items as an array, one item at a time, or save to CSV file.

Output Ports

out

Dynamic variables loaded from /component/appmixer/helpscout/core/FindConversations?outPort=out

notFound

Field	Type	Description
No fields defined for this port

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.helpscout.core.FindConversations", "author": "Appmixer <info@appmixer.com>", "description": "Search/list conversations using an advanced Help Scout query. Results are always sorted by modifiedAt in descending order (newest modified first).", "version": "1.0.0", "private": false, "auth": { "service": "appmixer:helpscout" }, "quota": { "manager": "appmixer:helpscout", "resources": "requests" }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "query": { "type": "string" }, "status": { "type": "string" }, "outputType": { "type": "string" } }, "required": [] }, "inspector": { "inputs": { "query": { "type": "textarea", "label": "Query", "index": 1, "tooltip": "Advanced Helpscout customer query. Example: `(subject:\"have a question\" AND tag:\"billing\")`. See the <a target=_blank href=\"https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/#query\">docs</a> for the full query syntax." }, "status": { "type": "select", "label": "Status", "index": 2, "defaultValue": "active", "tooltip": "Filter conversations by status.", "options": [ { "label": "Active", "value": "active" }, { "label": "All", "value": "all" }, { "label": "Closed", "value": "closed" }, { "label": "Open", "value": "open" }, { "label": "Pending", "value": "pending" }, { "label": "Spam", "value": "spam" } ] }, "outputType": { "type": "select", "label": "Output Type", "index": 3, "defaultValue": "array", "tooltip": "Choose how results are returned: first item only, all items as an array, one item at a time, or save to CSV file.", "options": [ { "label": "First Item Only", "value": "first" }, { "label": "All items at once", "value": "array" }, { "label": "One item at a time", "value": "object" }, { "label": "Store to CSV file", "value": "file" } ] } } } } ], "outPorts": [ { "name": "out", "source": { "url": "/component/appmixer/helpscout/core/FindConversations?outPort=out", "data": { "properties": { "generateOutputPortOptions": true }, "messages": { "in/outputType": "inputs/in/outputType" } } } }, { "name": "notFound" } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCEtLSBVcGxvYWRlZCB0bzogU1ZHIFJlcG8sIHd3dy5zdmdyZXBvLmNvbSwgR2VuZXJhdG9yOiBTVkcgUmVwbyBNaXhlciBUb29scyAtLT4KPHN2ZyB3aWR0aD0iODAwcHgiIGhlaWdodD0iODAwcHgiIHZpZXdCb3g9Ii0yNyAwIDMxMCAzMTAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQiPgogICAgPGc+CiAgICAgICAgPHBhdGggZD0iTTE4LjQzMiwxODAuOTY4NzI3IEwxMDguOTE2MzY0LDkwLjQ4NDM2MzYgQzEyMC42NDU4MTgsNzguOTQxMDkwOSAxMjcuOTA2OTA5LDYyLjc0MzI3MjcgMTI3LjkwNjkwOSw0NS4wNTYgQzEyNy45MDY5MDksMjcuNTU0OTA5MSAxMjAuODMyLDExLjU0MzI3MjcgMTA5LjQ3NDkwOSwwIEwxOC45OTA1NDU1LDkwLjQ4NDM2MzYgQzcuMjYxMDkwOTEsMTAyLjAyNzYzNiAwLDExOC4yMjU0NTUgMCwxMzUuOTEyNzI3IEMwLDE1My42IDcuMDc0OTA5MDksMTY5LjQyNTQ1NSAxOC40MzIsMTgwLjk2ODcyNyBaIE0yMzcuNTY4LDEyOC4wOTMwOTEgTDE0Ny4wODM2MzYsMjE4LjU3NzQ1NSBDMTM1LjM1NDE4MiwyMzAuMTIwNzI3IDEyOC4wOTMwOTEsMjQ2LjMxODU0NSAxMjguMDkzMDkxLDI2NC4wMDU4MTggQzEyOC4wOTMwOTEsMjgxLjUwNjkwOSAxMzUuMTY4LDI5Ny41MTg1NDUgMTQ2LjUyNTA5MSwzMDkuMDYxODE4IEwyMzcuMDA5NDU1LDIxOC41Nzc0NTUgQzI0OC43Mzg5MDksMjA3LjAzNDE4MiAyNTYsMTkwLjgzNjM2NCAyNTYsMTczLjE0OTA5MSBDMjU2LDE1NS40NjE4MTggMjQ4LjkyNTA5MSwxMzkuNjM2MzY0IDIzNy41NjgsMTI4LjA5MzA5MSBaIE0yMzcuMDA5NDU1LDkwLjY3MDU0NTUgQzI0OC43Mzg5MDksNzkuMTI3MjcyNyAyNTYsNjIuOTI5NDU0NSAyNTYsNDUuMjQyMTgxOCBDMjU2LDI3Ljc0MTA5MDkgMjQ4LjkyNTA5MSwxMS43Mjk0NTQ1IDIzNy41NjgsMC4xODYxODE4MTggTDE4Ljk5MDU0NTUsMjE4LjU3NzQ1NSBDNy4yNjEwOTA5MSwyMzAuMzA2OTA5IDAsMjQ2LjMxODU0NSAwLDI2NC4xOTIgQzAsMjgxLjY5MzA5MSA3LjA3NDkwOTA5LDI5Ny43MDQ3MjcgMTguNDMyLDMwOS4yNDggTDIzNy4wMDk0NTUsOTAuNjcwNTQ1NSBaIiBmaWxsPSIjMTI5MkVFIj4KDTwvcGF0aD4KICAgIDwvZz4KPC9zdmc+" }