FreshdeskSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Freshdesk connection the step signs in with. |
| How to find them | "list" or "search" or "autocomplete" |
| Query | Freshdesk searches companies on name, domain, created_at, updated_at and any custom field by name. A query may be 512 characters and answers at most 10 pages of 30. |
| Name starts with | text |
| Companies per call | 1 to 100. A filter query always answers pages of 30. |
| Fetch every page | Refuses past 5,000 companies rather than answering a short list. Name completion answers one page and never pages. |
| Pages at most | 1 to 10. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `freshdesk`) |
mode | "list" or "search" or "autocomplete", by default "list" |
query | textused when `mode` is "search" |
name | textused when `mode` is "autocomplete" |
limit | number, by default 100 |
returnAll | true/false, by default false |
maxPages | number, by default 10used when `mode` is "search" |
Output
| Field | Type |
|---|---|
companies | array |
companyCountCompanies in this answer | number |
hasMoreMore companies are waiting behind this page | boolean |
nextUrlFreshdesk's link to the next page | string |
Sample output, and the expression for each field
- companies[]
- companyCount0
- hasMorefalse
- nextUrl""
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"limit": 100,
"maxPages": 10,
"mode": "list",
"name": "",
"query": "",
"returnAll": false
},
"label": "Find companies",
"type": "freshdesk.findCompanies",
"version": 1
}