FlxpointAPI Help CenterBeta

Run Workflow

posthttps://api.flxpoint.com/workflow/run

Use this when you want to create workflow data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Run a workflow for a specific system event

Request

Bodyapplication/json

Key/value pairs that correspond to global object handles and their values

idinteger
Only required if you are managing the ID externally. Otherwise the workflow can be resovled using the `eventHandle` + `params`.
eventHandlestring
The handle of the event.
draftboolean
Run against the draft version
default false
paramsarray[GetWorkflowRequestParam]
[Optional] A set of key/value pairs that are used to uniquely identify a workflow.
keystringrequired
valueintegerrequired
objectsobjectrequired
A Map of object handles to their values. Modifications will be applied directly to these and returned in the response.
No properties documented.

Example request

post/workflow/run
curl -X POST "https://api.flxpoint.com/workflow/run" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "id": 0,
         "eventHandle": "string",
         "draft": true,
         "params": [
           {
             "key": "string",
             "value": 0
           }
         ],
         "objects": {}
       }'
Example body · application/json
{
  "id": 0,
  "eventHandle": "string",
  "draft": true,
  "params": [
    {
      "key": "string",
      "value": 0
    }
  ],
  "objects": {}
}

Responses

200Returns same shape as the request but with values passed in the objects field potentially updated by the workflow.application/json
idinteger
Only required if you are managing the ID externally. Otherwise the workflow can be resovled using the `eventHandle` + `params`.
eventHandlestring
The handle of the event.
draftboolean
Run against the draft version
default false
paramsarray[GetWorkflowRequestParam]
[Optional] A set of key/value pairs that are used to uniquely identify a workflow.
keystringrequired
valueintegerrequired
objectsobjectrequired
A Map of object handles to their values. Modifications will be applied directly to these and returned in the response.
No properties documented.
Example response
{
  "id": 0,
  "eventHandle": "string",
  "draft": true,
  "params": [
    {
      "key": "string",
      "value": 0
    }
  ],
  "objects": {}
}
400If you pass a `workflowId` and it cannot be found. Or if you pass a `event` and that even doesn't exist. If no workflow is associated to the event no error will occur.

No schema documented for this status.

OpenAPI fragment
{
  "post": {
    "summary": "Run Workflow",
    "description": "Run a workflow for a specific system event",
    "parameters": [],
    "requestBody": {
      "description": "Key/value pairs that correspond to global object handles and their values",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RunWorkflowRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Returns same shape as the request but with values passed in the objects field potentially updated by the workflow.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/RunWorkflowRequest"
            }
          }
        }
      },
      "400": {
        "description": "If you pass a `workflowId` and it cannot be found.\n\nOr if you pass a `event` and that even doesn't exist. If no workflow is associated to the event no error will occur."
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight