Get Bulk Action Status

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
Bulk action id: Bulk actions are started from the Pipefy UI (bulk edit, move, delete); the public API does not currently start one. The id is shown in the UI and stored for two hours. An unknown id does not return a payload.

Step 1: Query the status

bulkActionStatus returns the counters and descriptive status for one bulk action.

query {
  bulkActionStatus(id: "bulk-action-id-here") {
    id
    status
    numberOfBuckets
    processedBuckets
    erroredBuckets
    erroredRecordset
  }
}

Arguments

id (ID!, required): the bulk action id.

Sample response

{
  "data": {
    "bulkActionStatus": {
      "id": "bulk-action-id-here",
      "status": "PROCESSING",
      "numberOfBuckets": 10,
      "processedBuckets": 3,
      "erroredBuckets": 4,
      "erroredRecordset": "1,2,3,4"
    }
  }
}

status is ENQUEUED right after the action is queued, PROCESSING while buckets are running, and FINISHED when the action completes. erroredRecordset is a comma-separated list of record ids that failed, or null when nothing has failed.

Key Notes

Unknown id: status is non-null. An id that does not match a stored action comes back as a GraphQL nullability error, not as a bulkActionStatus payload.
Lifetime: the status expires after two hours. After that, the same id behaves as an unknown id.
No extra permission check: anyone who has the id can read that action's status. The id is the capability.