helpScout.json•13.6 kB
{
"nodeType": "n8n-nodes-base.helpScout",
"displayName": "Help Scout",
"description": "Consume Help Scout API",
"version": 1,
"properties": [
{
"name": "mailboxId",
"displayName": "Mailbox Name or ID",
"type": "options",
"default": "",
"description": "ID of a mailbox where the conversation is being created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "status",
"displayName": "Status",
"type": "options",
"default": "",
"description": "Conversation status",
"required": true,
"options": [
{
"name": "Active",
"value": "active"
},
{
"name": "Closed",
"value": "closed"
},
{
"name": "Pending",
"value": "pending"
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "subject",
"displayName": "Subject",
"type": "string",
"default": "",
"description": "Conversation’s subject",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "type",
"displayName": "Type",
"type": "options",
"default": "",
"description": "Conversation type",
"required": true,
"options": [
{
"name": "Chat",
"value": "chat"
},
{
"name": "Email",
"value": "email"
},
{
"name": "Phone",
"value": "phone"
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "resolveData",
"displayName": "Resolve Data",
"type": "boolean",
"default": true,
"description": "By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically.",
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "The Help Scout user assigned to the conversation",
"placeholder": "Add Field",
"options": [
{
"name": "assignTo",
"displayName": "Assign To",
"type": "number",
"default": 0,
"description": "The Help Scout user assigned to the conversation"
},
{
"name": "autoReply",
"displayName": "Auto Reply",
"type": "boolean",
"default": false,
"description": "Whether set to true, an auto reply will be sent as long as there is at least one customer thread in the conversation"
},
{
"name": "closedAt",
"displayName": "Closed At",
"type": "dateTime",
"default": "",
"description": "When the conversation was closed, only applicable for imported conversations"
},
{
"name": "createdAt",
"displayName": "Created At",
"type": "dateTime",
"default": "",
"description": "When this conversation was created - ISO 8601 date time"
},
{
"name": "customerEmail",
"displayName": "Customer Email",
"type": "string",
"default": ""
},
{
"name": "customerId",
"displayName": "Customer ID",
"type": "number",
"default": 0
},
{
"name": "imported",
"displayName": "Imported",
"type": "boolean",
"default": false,
"description": "Whether set to true, no outgoing emails or notifications will be generated"
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "threadsUi",
"displayName": "Threads",
"type": "fixedCollection",
"default": {},
"description": "The message text",
"placeholder": "Add Thread",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "conversationId",
"displayName": "Conversation ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"conversation"
],
"operation": [
"get"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"conversation"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1
},
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"conversation"
],
"returnAll": [
false
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Filters conversations by assignee ID",
"placeholder": "Add option",
"options": [
{
"name": "assignTo",
"displayName": "Assign To",
"type": "number",
"default": 0,
"description": "Filters conversations by assignee ID"
}
],
"typeOptions": {
"minValue": 0
},
"displayOptions": {
"show": {
"resource": [
"conversation"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "create",
"description": "Create a new conversation",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create a new conversation"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete a conversation"
},
{
"name": "Get",
"value": "get",
"description": "Get a conversation"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many conversations"
}
],
"displayOptions": {
"show": {
"resource": [
"conversation"
]
}
}
},
{
"name": "addressUi",
"displayName": "Address",
"type": "fixedCollection",
"default": {},
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"placeholder": "Add Address",
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"customer"
]
}
}
},
{
"name": "chatsUi",
"displayName": "Chat Handles",
"type": "fixedCollection",
"default": {},
"description": "Chat type",
"placeholder": "Add Chat Handle",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"customer"
]
}
}
},
{
"name": "emailsUi",
"displayName": "Emails",
"type": "fixedCollection",
"default": {},
"description": "Location for this email address",
"placeholder": "Add Email",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"customer"
]
}
}
},
{
"name": "phonesUi",
"displayName": "Phones",
"type": "fixedCollection",
"default": {},
"description": "Location for this phone",
"placeholder": "Add Phone",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"customer"
]
}
}
},
{
"name": "socialProfilesUi",
"displayName": "Social Profiles",
"type": "fixedCollection",
"default": {},
"description": "Type of social profile",
"placeholder": "Add Social Profile",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"customer"
]
}
}
},
{
"name": "websitesUi",
"displayName": "Websites",
"type": "fixedCollection",
"default": {},
"description": "Website URL",
"placeholder": "Add Website",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"customer"
]
}
}
},
{
"name": "customerId",
"displayName": "Customer ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"get"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Customer’s age",
"placeholder": "Add Field",
"options": [
{
"name": "age",
"displayName": "Age",
"type": "number",
"default": 1,
"description": "Customer’s age"
},
{
"name": "firstName",
"displayName": "First Name",
"type": "string",
"default": "",
"description": "First name of the customer. When defined it must be between 1 and 40 characters."
}
],
"typeOptions": {
"minValue": 1
},
"displayOptions": {
"show": {
"operation": [
"update"
],
"resource": [
"customer"
]
}
}
},
{
"name": "text",
"displayName": "Text",
"type": "string",
"default": "",
"description": "The chat text",
"required": true,
"displayOptions": {
"show": {
"resource": [
"thread"
],
"operation": [
"create"
]
}
}
},
{
"name": "attachmentsUi",
"displayName": "Attachments",
"type": "fixedCollection",
"default": {},
"description": "Attachment’s file name",
"placeholder": "Add Attachments",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"thread"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "conversation",
"options": [
{
"name": "Conversation",
"value": "conversation"
},
{
"name": "Customer",
"value": "customer"
},
{
"name": "Mailbox",
"value": "mailbox"
},
{
"name": "Thread",
"value": "thread"
}
]
}
],
"credentialsConfig": [
{
"name": "helpScoutOAuth2Api",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}