workflowActions

Get all workflow actions

Returns all workflow actions for the platform. Actions define what happens when a workflow trigger executes. Requires the WORKFLOW_ACTION.VIEW permission.

get/v{version}/workflow-actions

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/workflow-actions
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

limitinteger

The amount of records shown in the list

pageinteger

The page which is going to be shown

order_bystring

The parameter by which the response is ordered.

order_directionstring

The order direction by which the response is ordered.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
workflow_idstring

Workflow that owns this action.

type'SEND_EMAIL_TO_CUSTOMER' | 'EXPORT_TO_ERP' | 'SEND_WEBHOOK'

Action type that selects the matching action configuration.

descriptionstring nullable

Description of what this action does.

status'ACTIVE' | 'INACTIVE' | 'DRAFT' | 'ARCHIVED'

Status of the action.

created_atstring nullable

Date time when the action was created.

updated_atstring nullable

Date time when the action was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.