Get Bulk Job Status

freshworks_crm.get_job_status

ActionCRM & salesconnection required

Calls the Freshworks CRM API with the connection's credentials.

Read how a bulk upsert ended: whether it is still running, how many records succeeded and failed, and the reason for each failure.

Ask about Freshworks CRM All Freshworks CRM nodes Provider API docs ↗

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

1 field, 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
job_id The job id a bulk-upsert node returned.	string	Yes	—	—	—

Output

One shape.

result

Field	Type	Example
status IN_PROGRESS, SUCCESS or FAILED.	string	—
job_type_name The kind of job, such as BULK_UPSERT.	string	—
progress How far the job has got, as a percentage.	number	—
data.record_status.succeeded How many records the job wrote.	number	—
data.record_status.failed How many records the job rejected.	number	—
data.detailed_failure_report One entry per rejected record, naming the unique field that identified it and why Freshworks refused it.	array	—

{
  "data": {
    "detailed_failure_report": [],
    "record_status": {
      "failed": 0,
      "succeeded": 0
    }
  },
  "job_type_name": "",
  "progress": 0,
  "status": ""
}

Notes

Freshworks supports this endpoint for bulk-upsert jobs only.

Related Freshworks CRM nodes

See Get Bulk Job Status 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.

Book a technical demo Talk to sales