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.

Articles

Get Steps By Entry with Rest API v2

This endpoint allows you to retrieve all steps of the workflow for the specified entry. It can be accessed as a GET to /wp-json/gf/v2/entries/[entry_id]/workflows/steps

Get Steps By Form with Rest API v2

This endpoint allows you to retrieve all steps of the workflow for the specified form. It can be accessed as a GET to /wp-json/gf/v2/forms/[form_id]/workflows/steps

Process the current step with Rest API V2

This endpoint allows you to process the current step for the specified entry either in whole or as an assignee. It can be accessed as a POST to /gf/v2/entries/[entry_id]/workflow/steps/[step_id]/process.

Send To Step with Rest API V2

This endpoint allows you to send the specified entry to a different step in it’s workflow. It can be accessed as a POST to /gf/v2/entries/[entry_id]/workflow/steps/[step_id]/send

Incoming Webhook Create an Entry via Rest API V2

This endpoint allows external services to submit data directly into a form to create a new entry based on settings defined in the Incoming Webhook Create an Entry feed. It can be accessed as a POST to /wp-json/gf/v2/workflow/webhooks/[feed_id]/[key]

Get Specific Step with Rest API v2

This endpoint allows you to retrieve a specific step of the workflow for the specified entry. It can be accessed as a GET to /gf/v2/entries/[entry_id]/workflow/steps/[step_id]

Get Workflow Status with Rest API V2

This endpoint allows you to get the workflow status, and current step details if available, for an existing entry. It can be accessed as a GET to /wp-json/gf/v2/entries/[entry_id]/workflows/status

Restart Step with Rest API v2

This endpoint allows you to restart the current step of the workflow for the specified entry.

Get Current Step with Rest API v2

This endpoint allows you to retrieve the current step of the workflow for the specified entry. It can be accessed as a GET to /gf/v2/entries/[entry_id]/workflow/steps/current

Cancel Workflow with Rest API v2

This endpoint allows you to cancel the active workflow for the specified entry. It can be accessed as a POST to /wp-json/gf/v2/workflows/[entry_id]/cancel