Automations & Self-Service Actions

PreviousAudit Logs NextAutomation Suggestions

Last updated 9 months ago

Was this helpful?

Get Flows

get

/api/v1/flows

Authorizations

Query parameters

filtersFilters

sortsSorts

cursorCursor

sizeSize

includeTotalIncludetotal

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/flows' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "isActive": true,
      "needsApproval": false,
      "order": 0,
      "type": "automation",
      "arguments": {},
      "secrets": {},
      "createdAt": "2025-02-21T14:39:55.514Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T14:39:55.514Z",
      "updatedBy": 1,
      "triggers": [
        {
          "type": "onEvent",
          "inputSchema": {},
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq",
              "value": null
            }
          ],
          "event": {
            "resource": "entity",
            "action": [
              "create"
            ]
          }
        }
      ],
      "actions": [
        {
          "type": "upsertResource",
          "args": {},
          "id": "text",
          "title": "text",
          "description": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq",
              "value": null
            }
          ]
        }
      ],
      "outputs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "icon": "text",
          "title": "text",
          "description": "text",
          "type": "text",
          "format": "text"
        }
      },
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ]
}

Successful Response

Create Flow

post

/api/v1/flows

Authorizations

Query parameters

triggerTrigger flow

Body

idIdrequired

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

iconIcon

isActiveIsactive

needsApprovalNeedsapproval

orderOrder

typeFlowTyperequired

An enumeration.

Options: automation, selfServiceAction, scorecard, reference, workflow

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

outputsOutputs

tagsTags

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/flows' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","title":"text","isActive":true,"needsApproval":false,"order":0,"type":"automation","arguments":{},"secrets":{},"triggers":[{"type":"onEvent","inputSchema":{},"conditions":[{"field":"text","expression":false,"operator":"eq","value":null}],"event":{"resource":"entity","action":["create"]}}],"actions":[{"type":"upsertResource","args":{},"conditions":[{"field":"text","expression":false,"operator":"eq","value":null}]}],"outputs":{"ANY_ADDITIONAL_PROPERTY":{"value":"text"}},"tags":[{"key":"text","value":"text"}]}'

201

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "isActive": true,
  "needsApproval": false,
  "order": 0,
  "type": "automation",
  "arguments": {},
  "secrets": {},
  "createdAt": "2025-02-21T14:39:55.514Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T14:39:55.514Z",
  "updatedBy": 1,
  "triggers": [
    {
      "type": "onEvent",
      "inputSchema": {},
      "conditions": [
        {
          "field": "text",
          "expression": false,
          "operator": "eq",
          "value": null
        }
      ],
      "event": {
        "resource": "entity",
        "action": [
          "create"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "upsertResource",
      "args": {},
      "id": "text",
      "title": "text",
      "description": "text",
      "conditions": [
        {
          "field": "text",
          "expression": false,
          "operator": "eq",
          "value": null
        }
      ]
    }
  ],
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "icon": "text",
      "title": "text",
      "description": "text",
      "type": "text",
      "format": "text"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Successful Response

Get Flow

get

/api/v1/flows/{id_}

Authorizations

Path parameters

id_Id required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/flows/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "isActive": true,
  "needsApproval": false,
  "order": 0,
  "type": "automation",
  "arguments": {},
  "secrets": {},
  "createdAt": "2025-02-21T14:39:55.514Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T14:39:55.514Z",
  "updatedBy": 1,
  "triggers": [
    {
      "type": "onEvent",
      "inputSchema": {},
      "conditions": [
        {
          "field": "text",
          "expression": false,
          "operator": "eq",
          "value": null
        }
      ],
      "event": {
        "resource": "entity",
        "action": [
          "create"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "upsertResource",
      "args": {},
      "id": "text",
      "title": "text",
      "description": "text",
      "conditions": [
        {
          "field": "text",
          "expression": false,
          "operator": "eq",
          "value": null
        }
      ]
    }
  ],
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "icon": "text",
      "title": "text",
      "description": "text",
      "type": "text",
      "format": "text"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Successful Response

Upsert Flow

put

/api/v1/flows/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Query parameters

triggerTrigger flow

Body

idIdrequired

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

iconIcon

isActiveIsactive

needsApprovalNeedsapproval

orderOrder

typeFlowTyperequired

An enumeration.

Options: automation, selfServiceAction, scorecard, reference, workflow

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

outputsOutputs

tagsTags

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/flows/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","title":"text","isActive":true,"needsApproval":false,"order":0,"type":"automation","arguments":{},"secrets":{},"triggers":[{"type":"onEvent","inputSchema":{},"conditions":[{"field":"text","expression":false,"operator":"eq","value":null}],"event":{"resource":"entity","action":["create"]}}],"actions":[{"type":"upsertResource","args":{},"conditions":[{"field":"text","expression":false,"operator":"eq","value":null}]}],"outputs":{"ANY_ADDITIONAL_PROPERTY":{"value":"text"}},"tags":[{"key":"text","value":"text"}]}'

200

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "isActive": true,
  "needsApproval": false,
  "order": 0,
  "type": "automation",
  "arguments": {},
  "secrets": {},
  "createdAt": "2025-02-21T14:39:55.514Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T14:39:55.514Z",
  "updatedBy": 1,
  "triggers": [
    {
      "type": "onEvent",
      "inputSchema": {},
      "conditions": [
        {
          "field": "text",
          "expression": false,
          "operator": "eq",
          "value": null
        }
      ],
      "event": {
        "resource": "entity",
        "action": [
          "create"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "upsertResource",
      "args": {},
      "id": "text",
      "title": "text",
      "description": "text",
      "conditions": [
        {
          "field": "text",
          "expression": false,
          "operator": "eq",
          "value": null
        }
      ]
    }
  ],
  "outputs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "icon": "text",
      "title": "text",
      "description": "text",
      "type": "text",
      "format": "text"
    }
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Successful Response

Delete Flow

delete

/api/v1/flows/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/flows/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

No body

Successful Response

Get Suggestions

get

/api/v1/suggestions

Authorizations

Query parameters

searchQuerySearchquery

filtersFilters

sortsSorts

cursorCursor

sizeSize

includeTotalIncludetotal

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/suggestions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "originType": "automation",
      "originId": "text",
      "sourceType": "entity",
      "sourceId": "text",
      "sourceContext": {},
      "targetType": "entity",
      "targetId": "text",
      "targetContext": {},
      "targetIdOverride": "text",
      "data": {},
      "ignored": false,
      "autoApply": false,
      "lastAppliedAt": "2025-02-21T14:39:55.514Z",
      "createdAt": "2025-02-21T14:39:55.514Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T14:39:55.514Z",
      "updatedBy": 1,
      "additionalInfo": {}
    }
  ]
}

Successful Response

Create Suggestion

post

/api/v1/suggestions

Authorizations

Body

idId

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

originTypeOriginTyperequired

An enumeration.

Options: automation

originIdOriginidrequired

sourceTypeSourceTyperequired

An enumeration.

Options: entity

sourceIdSourceidrequired

sourceContextSourcecontext

targetTypeTargetTyperequired

An enumeration.

Options: entity

targetIdTargetidrequired

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/suggestions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","originType":"automation","originId":"text","sourceType":"entity","sourceId":"text","sourceContext":{},"targetType":"entity","targetId":"text","targetContext":{},"data":{},"ignored":false,"autoApply":false}'

201

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "sourceContext": {},
  "targetType": "entity",
  "targetId": "text",
  "targetContext": {},
  "targetIdOverride": "text",
  "data": {},
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-02-21T14:39:55.514Z",
  "createdAt": "2025-02-21T14:39:55.514Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T14:39:55.514Z",
  "updatedBy": 1,
  "additionalInfo": {}
}

Successful Response

Get Suggestion

get

/api/v1/suggestions/{id_}

Authorizations

Path parameters

id_Id required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/suggestions/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "sourceContext": {},
  "targetType": "entity",
  "targetId": "text",
  "targetContext": {},
  "targetIdOverride": "text",
  "data": {},
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-02-21T14:39:55.514Z",
  "createdAt": "2025-02-21T14:39:55.514Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T14:39:55.514Z",
  "updatedBy": 1,
  "additionalInfo": {}
}

Successful Response

Upsert Suggestion

put

/api/v1/suggestions/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Body

idId

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

originTypeOriginTyperequired

An enumeration.

Options: automation

originIdOriginidrequired

sourceTypeSourceTyperequired

An enumeration.

Options: entity

sourceIdSourceidrequired

sourceContextSourcecontext

targetTypeTargetTyperequired

An enumeration.

Options: entity

targetIdTargetidrequired

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/suggestions/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","originType":"automation","originId":"text","sourceType":"entity","sourceId":"text","sourceContext":{},"targetType":"entity","targetId":"text","targetContext":{},"data":{}}'

200

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "sourceContext": {},
  "targetType": "entity",
  "targetId": "text",
  "targetContext": {},
  "targetIdOverride": "text",
  "data": {},
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-02-21T14:39:55.514Z",
  "createdAt": "2025-02-21T14:39:55.514Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T14:39:55.514Z",
  "updatedBy": 1,
  "additionalInfo": {}
}

Successful Response

Delete Suggestion

delete

/api/v1/suggestions/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/suggestions/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

No body

Successful Response

Apply Suggestion

post

/api/v1/suggestions/{id_}/apply

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Query parameters

dryRunDry run applying suggestion and output changes

enableAutoApplyEnable auto-apply flag

deleteAfterApplyDelete suggestion after apply

Body

targetIdOverrideTargetidoverride

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/suggestions/{id_}/apply' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json'

200

422

{
  "dryRun": true,
  "ignored": true,
  "previousState": {},
  "newState": {}
}

Successful Response

Automations & Self-Service Actions

Automations & Self-Service Actions

Troubleshooting

Troubleshooting

Get Flows

Create Flow

Get Flow

Upsert Flow

Delete Flow

Get Suggestions

Create Suggestion

Get Suggestion

Upsert Suggestion

Delete Suggestion

Apply Suggestion