Skip to documentation
Brightree integration

Get Template Dispatch Batch Status

Perform Get Template Dispatch Batch Status through Brightree.

View as Markdown
brightree_get_template_dispatch_batch_status
readbrightree

Inputs

  • job_id
    expression
    Job Id

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • job_idJob Id
  • dispatcher_statusDispatcher Status
  • dispatcher_finishedDispatcher Finished
  • total_ordersTotal Orders
  • settledSettled
  • completedCompleted
  • failedFailed
  • skippedSkipped
  • in_flightIn Flight
  • not_startedNot Started
  • is_completeIs Complete
  • completed_order_keysCompleted Order Keys
  • failed_order_keysFailed Order Keys
  • skipped_order_keysSkipped Order Keys
  • in_flight_order_keysIn Flight Order Keys
  • not_started_order_keysNot Started Order Keys
  • messageMessage
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
read
Confirmation recommended
No
Retry safe
Yes
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "properties": {
    "job_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "failed": {},
    "job_id": {},
    "message": {},
    "settled": {},
    "skipped": {},
    "success": {},
    "completed": {},
    "in_flight": {},
    "is_complete": {},
    "not_started": {},
    "total_orders": {},
    "dispatcher_status": {},
    "failed_order_keys": {},
    "skipped_order_keys": {},
    "dispatcher_finished": {},
    "completed_order_keys": {},
    "in_flight_order_keys": {},
    "not_started_order_keys": {}
  },
  "additionalProperties": true
}
View all Brightree actions