Introduction
Properties
| Key | Type | Description |
|---|---|---|
| final_status | String | Final status of the workflow that could be a value of: pending, complete, approved, rejected. ‘pending’ the most likely option unless your workflow has no user interactive steps. |
| timestamp | Integer | The workflow last update as a Unix timestamp; the number of seconds since the Unix epoch on January 1st, 1970 at UTC. |
| current_step | Array or Null | The current step the restarted workflow is on. This will be null if the workflow has no active steps or no interactive ones where final_status = pending. |
Workflow Status JSON
This example shows how an Workflow Status array would look when formatted as JSON for use by the Gravity Flow Rest API V2.
A complete workflow
{
"final_status": "complete",
"timestamp": "1759859399",
"current_step": null
}
An active workflow
{
"final_status": "pending",
"timestamp": "1759859399",
"current_step": {
"id": 1188,
"type": "approval",
"label": "Approval",
"name": "Example Approval Step",
"is_active": true,
"entry_count": 1,
"supports_expiration": true,
"assignees": [
{
"key": "user_id|1",
"id": "1",
"type": "user_id",
"display_name": "admin",
"status": "pending"
}
],
"settings": {
"step_name": "Example Approval Step",
"description": "",
"step_type": "approval",
"step_highlight": "0",
"step_highlight_type": "color",
"step_highlight_color": "#dd3333",
"feed_condition_conditional_logic_object": [],
"feed_condition_conditional_logic": "0",
"scheduled": "0",
"schedule_type": "delay",
"schedule_date": "",
"schedule_delay_offset": "",
"schedule_delay_unit": "hours",
"schedule_date_field_offset": "0",
"schedule_date_field_offset_unit": "hours",
"schedule_date_field_before_after": "after",
"type": "select",
"assignees": [
"user_id|1"
],
"routing": "",
"assignee_policy": "all",
"instructionsEnable": "0",
"instructionsValue": "Instructions: please review the values in the fields below and click on the Approve or Reject button",
"display_fields_mode": "all_fields",
"confirmation_prompt": "0",
"revertEnable": "1",
"revertValue": "1189",
"assignee_notification_enabled": "0",
"assignee_notification_from_name": "",
"assignee_notification_from_email": "{admin_email}",
"assignee_notification_reply_to": "",
"assignee_notification_cc": "",
"assignee_notification_bcc": "",
"assignee_notification_subject": "",
"assignee_notification_message": "A new entry is pending your approval. Please check your Workflow Inbox.",
"assignee_notification_disable_autoformat": "0",
"resend_assignee_emailEnable": "0",
"resend_assignee_emailValue": "7",
"resend_assignee_email_repeatEnable": "0",
"resend_assignee_email_repeatValue": "3",
"rejection_notification_enabled": "0",
"rejection_notification_type": "select",
"rejection_notification_routing": [
{
"assignee": "user_id|1",
"fieldId": "0",
"operator": "is",
"value": "",
"type": ""
}
],
"rejection_notification_from_name": "",
"rejection_notification_from_email": "{admin_email}",
"rejection_notification_reply_to": "",
"rejection_notification_cc": "",
"rejection_notification_bcc": "",
"rejection_notification_subject": "",
"rejection_notification_message": "Entry {entry_id} has been rejected",
"rejection_notification_disable_autoformat": "0",
"approval_notification_enabled": "0",
"approval_notification_type": "select",
"approval_notification_routing": [
{
"assignee": "user_id|1",
"fieldId": "0",
"operator": "is",
"value": "",
"type": ""
}
],
"approval_notification_from_name": "",
"approval_notification_from_email": "{admin_email}",
"approval_notification_reply_to": "",
"approval_notification_cc": "",
"approval_notification_bcc": "",
"approval_notification_subject": "",
"approval_notification_message": "Entry {entry_id} has been approved",
"approval_notification_disable_autoformat": "0",
"revert_notification_enabled": "0",
"revert_notification_type": "select",
"revert_notification_routing": [
{
"assignee": "user_id|1",
"fieldId": "0",
"operator": "is",
"value": "",
"type": ""
}
],
"revert_notification_from_name": "",
"revert_notification_from_email": "{admin_email}",
"revert_notification_reply_to": "",
"revert_notification_cc": "",
"revert_notification_bcc": "",
"revert_notification_subject": "",
"revert_notification_message": "Entry {entry_id} has been reverted",
"revert_notification_disable_autoformat": "0",
"note_mode": "not_required",
"approved_messageEnable": "0",
"approved_messageValue": "Entry Approved",
"reverted_messageEnable": "0",
"reverted_messageValue": "Entry Reverted",
"rejected_messageEnable": "0",
"rejected_messageValue": "Entry Rejected",
"processed_step_messageEnable": "0",
"processed_step_messageValue": "This link is no longer valid.",
"due_date": "0",
"due_date_type": "delay",
"due_date_date": "",
"due_date_delay_offset": "",
"due_date_delay_unit": "hours",
"due_date_date_field_offset": "0",
"due_date_date_field_offset_unit": "hours",
"due_date_date_field_before_after": "after",
"due_date_highlight_type": "color",
"due_date_highlight_color": "#dd3333",
"expiration": "0",
"expiration_type": "delay",
"expiration_date": "",
"expiration_delay_offset": "",
"expiration_delay_unit": "hours",
"expiration_date_field_offset": "0",
"expiration_date_field_offset_unit": "hours",
"expiration_date_field_before_after": "after",
"status_expiration": "rejected",
"destination_expired": "next",
"destination_rejected": "complete",
"destination_approved": "next",
"highlight": "",
"condition": "",
"editable_fields": "",
"instructions": "",
"display_fields": "",
"revert": "",
"notification_tabs": "",
"approved_message": "",
"reverted_message": "",
"rejected_message": "",
"processed_step_message": "",
"_entry_count": 1
},
"is_current_step": true,
"status": "pending",
"expiration_timestamp": false,
"is_expired": false,
"is_queued": false
}
}