FreshdeskSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Freshdesk connection the step signs in with. |
| How to find them | "list" or "search" |
| text | |
| Mobile | text |
| Phone | text |
| Company id | text |
| State | "" or "blocked" or "deleted" or "unverified" or "verified" |
| Updated since | text |
| Query | Freshdesk searches contacts on name, email, phone, mobile, company_id, state, created_at, updated_at and any custom field by name. A query may be 512 characters and answers at most 10 pages of 30. |
| Contacts per call | 1 to 100. A filter query always answers pages of 30. |
| Fetch every page | Refuses past 5,000 contacts rather than answering a short list. A query stops at 10 pages of 30 whatever you set. |
| Pages at most | 1 to 10. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `freshdesk`) |
mode | "list" or "search", by default "list" |
email | textused when `mode` is "list" |
mobile | textused when `mode` is "list" |
phone | textused when `mode` is "list" |
companyId | textused when `mode` is "list" |
state | "" or "blocked" or "deleted" or "unverified" or "verified"used when `mode` is "list" |
updatedSince | textused when `mode` is "list" |
query | textused when `mode` is "search" |
limit | number, by default 100 |
returnAll | true/false, by default false |
maxPages | number, by default 10used when `mode` is "search" |
Output
| Field | Type |
|---|---|
contacts | array |
contactCountContacts in this answer | number |
totalMatches Freshdesk counted (a query only) | number |
hasMoreMore contacts are waiting behind this page | boolean |
nextUrlFreshdesk's link to the next page | string |
Sample output, and the expression for each field
- contactCount0
- contacts[]
- hasMorefalse
- nextUrl""
- total0
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": {
"companyId": "",
"connection": "<connection id>",
"email": "",
"limit": 100,
"maxPages": 10,
"mobile": "",
"mode": "list",
"phone": "",
"query": "",
"returnAll": false,
"state": "",
"updatedSince": ""
},
"label": "Find contacts",
"type": "freshdesk.findContacts",
"version": 1
}