Get Deal
freshworks_crm.get_deal
ActionCRM & salesconnection required
Calls the Freshworks CRM API with the connection's credentials.
Fetch one deal by its Freshworks id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Freshworks CRM
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- bundle_alias, domain, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
deal_id The Freshworks id of the deal to act on. | string | Yes | — | — | — |
include Comma-separated related resources to embed in the response, such as 'owner,targetable'. Freshworks documents which values each resource accepts. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deal The deal record, inside the 'deal' envelope Freshworks returns it in. | object | — |
deal.id The Freshworks id of the deal. | number | — |
{
"deal": {
"id": 0
}
}See Get Deal run in a workflow.
In a technical demo we add the Freshworks CRM connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.