Get Bulk Action
contentful.get_bulk_action
ActionBusiness appsconnection required
Calls the Contentful API with the connection's credentials.
Poll one bulk publish or unpublish job for its status and any errors.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Contentful
- Secret shape
- the CMA access token, or {"access_token": "…"}
- Config it needs
- space_id, environment_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 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 |
|---|---|---|---|---|---|
bulk_action_id The id returned by contentful.bulk_publish or contentful.bulk_unpublish. | string | Yes | — | — | — |
space_id The space to act on. Leave blank to use the connection's space. | string | No | — | — | — |
environment_id The environment to act on. Leave blank to use the connection's environment, or 'master'. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
bulk_action_id The bulk action's id, to poll with get_bulk_action. | string | — |
status created, inProgress, succeeded or failed. | string | — |
action The action the job performs: publish or unpublish. | string | — |
completed False while the job is still created or inProgress. | boolean | — |
succeeded True only once the job reached the succeeded state. | boolean | — |
error Contentful's per-entity error detail when the job failed. | object | — |
entity_ids The ids the job covers. | array | — |
entity_count How many entities the job covers. | number | — |
space_id The space the job runs in. | string | — |
environment_id The environment the job runs in. | string | — |
{
"action": "",
"bulk_action_id": "",
"completed": false,
"entity_count": 0,
"entity_ids": [],
"environment_id": "",
"error": {},
"space_id": "",
"status": "",
"succeeded": false
}See Get Bulk Action run in a workflow.
In a technical demo we add the Contentful connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.