freshworksCrm.json•26.8 kB
{
"nodeType": "n8n-nodes-base.freshworksCrm",
"displayName": "Freshworks CRM",
"description": "Consume the Freshworks CRM API",
"version": 1,
"properties": [
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Name of the account",
"required": true,
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Address of the account",
"placeholder": "Add Field",
"options": [
{
"name": "address",
"displayName": "Address",
"type": "string",
"default": "",
"description": "Address of the account"
},
{
"name": "annual_revenue",
"displayName": "Annual Revenue",
"type": "number",
"default": 0,
"description": "Annual revenue of the account"
},
{
"name": "business_type_id",
"displayName": "Business Type Name or ID",
"type": "options",
"default": "",
"description": "ID of the business that the account belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "city",
"displayName": "City",
"type": "string",
"default": "",
"description": "City that the account belongs to"
},
{
"name": "country",
"displayName": "Country",
"type": "string",
"default": "",
"description": "Country that the account belongs to"
},
{
"name": "facebook",
"displayName": "Facebook",
"type": "string",
"default": "",
"description": "Facebook username of the account"
},
{
"name": "industry_type_id",
"displayName": "Industry Type Name or ID",
"type": "options",
"default": "",
"description": "ID of the industry that the account belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "linkedin",
"displayName": "LinkedIn",
"type": "string",
"default": "",
"description": "LinkedIn account of the account"
},
{
"name": "number_of_employees",
"displayName": "Number of Employees",
"type": "number",
"default": 0,
"description": "Number of employees in the account"
},
{
"name": "owner_id",
"displayName": "Owner Name or ID",
"type": "options",
"default": "",
"description": "ID of the user to whom the account is assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "parent_sales_account_id",
"displayName": "Parent Sales Account ID",
"type": "string",
"default": "",
"description": "Parent account ID of the account"
},
{
"name": "phone",
"displayName": "Phone",
"type": "string",
"default": "",
"description": "Phone number of the account"
},
{
"name": "state",
"displayName": "State",
"type": "string",
"default": "",
"description": "State that the account belongs to"
},
{
"name": "territory_id",
"displayName": "Territory Name or ID",
"type": "options",
"default": "",
"description": "ID of the territory that the account belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "twitter",
"displayName": "Twitter",
"type": "string",
"default": "",
"description": "Twitter username of the account"
},
{
"name": "website",
"displayName": "Website",
"type": "string",
"default": "",
"description": "Website of the account"
},
{
"name": "zipcode",
"displayName": "Zipcode",
"type": "string",
"default": "",
"description": "Zipcode of the region that the account belongs to"
}
],
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"create"
]
}
}
},
{
"name": "accountId",
"displayName": "Account ID",
"type": "string",
"default": "",
"description": "ID of the account to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"delete"
]
}
}
},
{
"name": "view",
"displayName": "View Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1
},
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Address of the account",
"placeholder": "Add Field",
"options": [
{
"name": "address",
"displayName": "Address",
"type": "string",
"default": "",
"description": "Address of the account"
},
{
"name": "annual_revenue",
"displayName": "Annual Revenue",
"type": "number",
"default": 0,
"description": "Annual revenue of the account"
},
{
"name": "business_type_id",
"displayName": "Business Type Name or ID",
"type": "options",
"default": "",
"description": "ID of the business that the account belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "city",
"displayName": "City",
"type": "string",
"default": "",
"description": "City that the account belongs to"
},
{
"name": "country",
"displayName": "Country",
"type": "string",
"default": "",
"description": "Country that the account belongs to"
},
{
"name": "facebook",
"displayName": "Facebook",
"type": "string",
"default": "",
"description": "Facebook username of the account"
},
{
"name": "industry_type_id",
"displayName": "Industry Type Name or ID",
"type": "options",
"default": "",
"description": "ID of the industry that the account belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "linkedin",
"displayName": "LinkedIn",
"type": "string",
"default": "",
"description": "LinkedIn account of the account"
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Name of the account"
},
{
"name": "number_of_employees",
"displayName": "Number of Employees",
"type": "number",
"default": 0,
"description": "Number of employees in the account"
},
{
"name": "owner_id",
"displayName": "Owner Name or ID",
"type": "options",
"default": "",
"description": "ID of the user to whom the account is assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "parent_sales_account_id",
"displayName": "Parent Sales Account ID",
"type": "string",
"default": "",
"description": "Parent account ID of the account"
},
{
"name": "phone",
"displayName": "Phone",
"type": "string",
"default": "",
"description": "Phone number of the account"
},
{
"name": "state",
"displayName": "State",
"type": "string",
"default": "",
"description": "State that the account belongs to"
},
{
"name": "territory_id",
"displayName": "Territory Name or ID",
"type": "options",
"default": "",
"description": "ID of the territory that the account belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "twitter",
"displayName": "Twitter",
"type": "string",
"default": "",
"description": "Twitter username of the account"
},
{
"name": "website",
"displayName": "Website",
"type": "string",
"default": "",
"description": "Website of the account"
},
{
"name": "zipcode",
"displayName": "Zipcode",
"type": "string",
"default": "",
"description": "Zipcode of the region that the account belongs to"
}
],
"displayOptions": {
"show": {
"resource": [
"account"
],
"operation": [
"update"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "create",
"description": "Create an account",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create an account"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete an account"
},
{
"name": "Get",
"value": "get",
"description": "Retrieve an account"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Retrieve many accounts"
},
{
"name": "Update",
"value": "update",
"description": "Update an account"
}
],
"displayOptions": {
"show": {
"resource": [
"account"
]
}
}
},
{
"name": "title",
"displayName": "Title",
"type": "string",
"default": "",
"description": "Title of the appointment",
"required": true,
"displayOptions": {
"show": {
"resource": [
"appointment"
],
"operation": [
"create"
]
}
}
},
{
"name": "fromDate",
"displayName": "Start Date",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes the start of appointment. Start date if this is an all-day appointment.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"appointment"
],
"operation": [
"create"
]
}
}
},
{
"name": "endDate",
"displayName": "End Date",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes the end of appointment. End date if this is an all-day appointment.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"appointment"
],
"operation": [
"create"
]
}
}
},
{
"name": "attendees",
"displayName": "Attendees",
"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 Attendee",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"appointment"
],
"operation": [
"create"
]
}
}
},
{
"name": "appointmentId",
"displayName": "Appointment ID",
"type": "string",
"default": "",
"description": "ID of the appointment to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"appointment"
],
"operation": [
"delete"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"placeholder": "Add Filter",
"displayOptions": {
"show": {
"resource": [
"appointment"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "firstName",
"displayName": "First Name",
"type": "string",
"default": "",
"description": "First name of the contact",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
]
}
}
},
{
"name": "lastName",
"displayName": "Last Name",
"type": "string",
"default": "",
"description": "Last name of the contact",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
]
}
}
},
{
"name": "emails",
"displayName": "Email Address",
"type": "string",
"default": "",
"description": "Email addresses of the contact",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
]
}
}
},
{
"name": "contactId",
"displayName": "Contact ID",
"type": "string",
"default": "",
"description": "ID of the contact to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"delete"
]
}
}
},
{
"name": "amount",
"displayName": "Amount",
"type": "number",
"default": 0,
"description": "Value of the deal",
"required": true,
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"create"
]
}
}
},
{
"name": "dealId",
"displayName": "Deal ID",
"type": "string",
"default": "",
"description": "ID of the deal to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"delete"
]
}
}
},
{
"name": "description",
"displayName": "Content",
"type": "string",
"default": "",
"description": "Content of the note",
"required": true,
"typeOptions": {
"rows": 5
},
"displayOptions": {
"show": {
"resource": [
"note"
],
"operation": [
"create"
]
}
}
},
{
"name": "targetableType",
"displayName": "Target Type",
"type": "options",
"default": "Contact",
"description": "Type of the entity for which the note is created",
"required": true,
"options": [
{
"name": "Contact",
"value": "Contact"
},
{
"name": "Deal",
"value": "Deal"
},
{
"name": "Sales Account",
"value": "SalesAccount"
}
],
"displayOptions": {
"show": {
"resource": [
"note"
],
"operation": [
"create"
]
}
}
},
{
"name": "targetable_id",
"displayName": "Target ID",
"type": "string",
"default": "",
"description": "ID of the entity for which note is created. The type of entity is selected in \"Target Type\".",
"required": true,
"displayOptions": {
"show": {
"resource": [
"note"
],
"operation": [
"create"
]
}
}
},
{
"name": "noteId",
"displayName": "Note ID",
"type": "string",
"default": "",
"description": "ID of the note to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"note"
],
"operation": [
"delete"
]
}
}
},
{
"name": "sales_activity_type_id",
"displayName": "Sales Activity Type Name or ID",
"type": "options",
"default": "",
"description": "ID of a sales activity type for which the sales activity is created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"displayOptions": {
"show": {
"resource": [
"salesActivity"
],
"operation": [
"create"
]
}
}
},
{
"name": "ownerId",
"displayName": "Owner Name or ID",
"type": "options",
"default": "",
"description": "ID of the user who owns the sales activity. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"salesActivity"
],
"operation": [
"create"
]
}
}
},
{
"name": "from_date",
"displayName": "Start Date",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes the end of sales activity",
"required": true,
"displayOptions": {
"show": {
"resource": [
"salesActivity"
],
"operation": [
"create"
]
}
}
},
{
"name": "end_date",
"displayName": "End Date",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes the end of sales activity",
"required": true,
"displayOptions": {
"show": {
"resource": [
"salesActivity"
],
"operation": [
"create"
]
}
}
},
{
"name": "salesActivityId",
"displayName": "Sales Activity ID",
"type": "string",
"default": "",
"description": "ID of the salesActivity to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"salesActivity"
],
"operation": [
"delete"
]
}
}
},
{
"name": "query",
"displayName": "Search Term",
"type": "string",
"default": "",
"description": "Enter a term that will be used for searching entities",
"required": true,
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"query"
]
}
}
},
{
"name": "entities",
"displayName": "Search on Entities",
"type": "multiOptions",
"default": [],
"description": "Enter a term that will be used for searching entities",
"required": true,
"options": [
{
"name": "Contact",
"value": "contact"
},
{
"name": "Deal",
"value": "deal"
},
{
"name": "Sales Account",
"value": "sales_account"
},
{
"name": "User",
"value": "user"
}
],
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"query"
]
}
}
},
{
"name": "searchField",
"displayName": "Search Field",
"type": "options",
"default": "",
"description": "Only allowed custom fields of type \"Text field\", \"Number\", \"Dropdown\" or \"Radio button\"",
"required": true,
"options": [
{
"name": "Email",
"value": "email"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Custom Field",
"value": "customField",
"description": "Only allowed custom fields of type \"Text field\", \"Number\", \"Dropdown\" or \"Radio button\""
}
],
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"lookup"
]
}
}
},
{
"name": "customFieldName",
"displayName": "Custom Field Name",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"lookup"
],
"searchField": [
"customField"
]
}
}
},
{
"name": "customFieldValue",
"displayName": "Custom Field Value",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"lookup"
],
"searchField": [
"customField"
]
}
}
},
{
"name": "fieldValue",
"displayName": "Field Value",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"lookup"
],
"searchField": [
"email",
"name"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Use 'entities' to query against related entities. You can include multiple entities at once, provided the field is available in both entities or else you'd receive an error response.",
"placeholder": "Add option",
"displayOptions": {
"show": {
"resource": [
"search"
],
"operation": [
"lookup"
]
}
}
},
{
"name": "dueDate",
"displayName": "Due Date",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes when the task is due to be completed",
"required": true,
"displayOptions": {
"show": {
"resource": [
"task"
],
"operation": [
"create"
]
}
}
},
{
"name": "taskId",
"displayName": "Task ID",
"type": "string",
"default": "",
"description": "ID of the task to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"task"
],
"operation": [
"delete"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "account",
"options": [
{
"name": "Account",
"value": "account"
},
{
"name": "Appointment",
"value": "appointment"
},
{
"name": "Contact",
"value": "contact"
},
{
"name": "Deal",
"value": "deal"
},
{
"name": "Note",
"value": "note"
},
{
"name": "Sales Activity",
"value": "salesActivity"
},
{
"name": "Search",
"value": "search"
},
{
"name": "Task",
"value": "task"
}
]
}
],
"credentialsConfig": [
{
"name": "freshworksCrmApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}