Developers
Gravity Flow Actions and Filters
Understand what hooks Gravity Flow provides, which parameters are available to them and examples of how they can be used to customize the default plugin behaviour to suit your use case / needs.
Extension Actions and Filters
Understand what hooks each Gravity Flow extension provides, which parameters are available to them and how they can be used to customize the default behaviours to suit your use case / needs.
REST API V2
This section of documentation lists articles related to the REST API v2 for Gravity Flow.
REST API V1
This section of documentation lists articles related to the REST API v1 for Gravity Flow.
Class Objects
Reference for the main PHP classes that power Gravity Flow. Each entry describes the class purpose, available methods and properties, and how developers can extend or override behavior.
Data Objects
Articles
Restart Workflow with Rest API V2
This endpoint allows you to restart the workflow for the specified entry. It can be accessed as a POST to /wp-json/gf/v2/entries/[entry_id]/workflows/restart
Workflow Status Object
KeyTypeDescriptionfinal_statusStringFinal status of the workflow that could be a value of: pending, complete, approved, rejected.
Workflow Step Object
Each step object will have different properties based on a number of factors including:
The Common Step Settings that will apply to every step.
Process Incoming Webhook with Rest API v2
This endpoint allows external services to submit data to complete an incoming webhook step with field values mapped based on settings defined in the Incoming Webhook step. It can be accessed as a POST to /wp-json/gf/v2/entries/[entry_id]/workflow-hooks
gravityflow_rest_api_capability_restart_workflow
The gravityflow_rest_api_capability_restart_workflow filter allows customization of the capabilities an authenticated request for restarting a workflow is checked against.
gravityflow_rest_api_capability_cancel_workflow
The gravityflow_rest_api_capability_cancel_workflow filter allows customization of the capabilities an authenticated request for cancelling a workflow is checked against.
gravityflow_assignee_ajax_search
gravityflow_assignee_ajax_search filter allows customization of AJAX-powered search for assignee list in workflow step and conditional routing settings.
gravityflow_assignee_ajax_search_account_threshold
gravityflow_assignee_ajax_search_account_threshold filter allows customization of the minimum number of users in a site which would trigger the assignee/conditional routing settings to use the ajax search behaviour
POST Process Incoming Webhook API v1
The Incoming Webhook endpoint processes a POST request with the step’s API key and secret, optionally updating entry fields before continuing the workflow.
GET Entries Assignees REST API v1
The Get Entries Assignees endpoint retrieves assignee details for a specific entry, with the option to filter by assignee_key.