Trigger a workflow

Trigger and query workflows using the Nexthink API.

Trigger a workflow V1

post

Triggers the execution of a workflow.

Authorizations

publicApiAuth

OAuth2clientCredentialsRequired

Token URL:

Header parameters

AuthorizationstringRequired

Sourcestring · nullableOptional

Body

application/json

workflowIdstringRequired

The ID of the workflow to execute.

Example: #workflow_example

devicesstring[] · max: 10000Required

Nexthink Collector IDs of the devices that the workflow should be executed on. Note: If devices are included in the request, then users are optional by default.

usersstring[] · max: 10000Required

The security IDs of the users that the workflow would target. Note: If users are included in the request, then devices are optional by default.

Responses

200

Successful execution response.

application/json

Each request spawns one or more executions depending on the input. All executions will have the same request ID and a unique execution ID.

requestUuidstring · min: 1Required

The request ID. Use this ID to query workflow executions in NQL workflow.executions.request_id.

Example: 7fbd96a7-b717-43a7-8973-9c6adbca3a56

executionsUuidsstring[] · min: 1Required

A list of execution ID for each object targeted workflow.executions.execution_id.

400

Bad request - invalid request, see error code for details.

application/json

401

Unauthorized - no valid authentication credentials.

403

No permission - no permission to execute workflow.

application/json

post

/api/v1/workflows/execute

HTTPcURLJavaScriptPython

POST /api/v1/workflows/execute HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "workflowId": "#workflow_example",
  "devices": [
    "text"
  ],
  "users": [
    "text"
  ],
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "requestUuid": "7fbd96a7-b717-43a7-8973-9c6adbca3a56",
  "executionsUuids": [
    "text"
  ]
}

Trigger a workflow V2

post

Triggers the execution of a workflow using external identifiers for users and devices. For users, provide at least one of the following:

• sid: The security identifier of the user

• upn: The user's principal name (email format)

• uid: A globally unique user identifier For devices, provide at least one of the following:

• collectorUid: The Collector UUID of the device

• name: The name of the device

• uid: A globally unique device identifier If multiple users or devices match the identifiers, the system triggers the workflow on the most recently active one (lastSeen).

Authorizations

publicApiAuth

OAuth2clientCredentialsRequired

Token URL:

Header parameters

AuthorizationstringRequired

Sourcestring · nullableOptional

Body

application/json

workflowIdstringRequired

The ID of the workflow to execute.

Example: #workflow_example

Responses

200

Successful execution response.

application/json

Each request spawns one or more executions depending on the input. All executions will have the same request ID and a unique execution ID.

requestUuidstring · min: 1Required

The request ID. Use this ID to query workflow executions in NQL workflow.executions.request_id.

Example: 7fbd96a7-b717-43a7-8973-9c6adbca3a56

executionsUuidsstring[] · min: 1Required

A list of execution ID for each object targeted workflow.executions.execution_id.

400

Bad request - invalid request, see error code for details.

application/json

401

Unauthorized - no valid authentication credentials.

403

No permission - no permission to execute workflow.

application/json

post

/api/v2/workflows/execute

HTTPcURLJavaScriptPython

POST /api/v2/workflows/execute HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "workflowId": "#workflow_example",
  "devices": [
    {
      "name": "text",
      "uid": "text",
      "collectorUid": "text"
    }
  ],
  "users": [
    {
      "uid": "text",
      "upn": "text",
      "sid": "text"
    }
  ],
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "requestUuid": "7fbd96a7-b717-43a7-8973-9c6adbca3a56",
  "executionsUuids": [
    "text"
  ]
}

Trigger wait for event

post

Triggers a waiting workflow execution.

Authorizations

publicApiAuth

OAuth2clientCredentialsRequired

Token URL:

Path parameters

workflowUuidstringRequiredPattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

executionUuidstringRequiredPattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Header parameters

Sourcestring · nullableOptional

Body

application/json

Responses

200

Returns a request identifier.

application/json

requestUuidstring · uuidRequired

The request ID.

Example: 123e4567-e89b-42d3-a456-556642440000

400

Bad request - invalid request, see error code for details.

application/json

401

Unauthorized - no valid authentication credentials.

403

No permission - not authorized to execute workflow.

application/json

post

/api/v1/workflows/workflows/{workflowUuid}/execution/{executionUuid}/trigger

HTTPcURLJavaScriptPython

POST /api/v1/workflows/workflows/{workflowUuid}/execution/{executionUuid}/trigger HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

[
  {
    "requestUuid": "123e4567-e89b-42d3-a456-556642440000"
  }
]

List workflows

get

Returns a list of workflows, including their configuration information. Use query parameters to filter the list of the workflows.

Authorizations

publicApiAuth

OAuth2clientCredentialsRequired

Token URL:

Query parameters

dependencystring · enumRequiredPossible values:

triggerMethodstring · enumRequiredPossible values:

fetchOnlyActiveWorkflowsbooleanOptional

Header parameters

Sourcestring · nullableOptional

Responses

200

List of workflows and their configurations.

application/json

idstringRequired

uuidstringRequired

namestringRequired

descriptionstringRequired

statusstring · enumRequiredPossible values:

lastUpdateTimestring · date-timeRequired

400

Bad request - invalid request, see error code for details.

application/json

401

Unauthorized - no valid authentication credentials.

403

No permission - not authorized to execute workflow.

application/json

get

/api/v1/workflows

HTTPcURLJavaScriptPython

GET /api/v1/workflows?dependency=USER&triggerMethod=API HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "uuid": "text",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "lastUpdateTime": "2026-03-02T16:38:16.642Z",
    "triggerMethods": {
      "id": "text",
      "uuid": "text",
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "lastUpdateTime": "2026-03-02T16:38:16.642Z",
      "triggerMethods": {
        "id": "text",
        "uuid": "text",
        "name": "text",
        "description": "text",
        "status": "ACTIVE",
        "lastUpdateTime": "2026-03-02T16:38:16.642Z",
        "triggerMethods": {
          "id": "text",
          "uuid": "text",
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "lastUpdateTime": "2026-03-02T16:38:16.642Z",
          "triggerMethods": {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": "[Circular Reference]",
            "versions": "[Circular Reference]"
          },
          "versions": [
            "[Circular Reference]"
          ]
        },
        "versions": [
          {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": {
              "id": "text",
              "uuid": "text",
              "name": "text",
              "description": "text",
              "status": "ACTIVE",
              "lastUpdateTime": "2026-03-02T16:38:16.642Z",
              "triggerMethods": {
                "id": "text",
                "uuid": "text",
                "name": "text",
                "description": "text",
                "status": "ACTIVE",
                "lastUpdateTime": "2026-03-02T16:38:16.642Z",
                "triggerMethods": "[Circular Reference]",
                "versions": "[Circular Reference]"
              },
              "versions": [
                "[Circular Reference]"
              ]
            },
            "versions": "[Circular Reference]"
          }
        ]
      },
      "versions": [
        {
          "id": "text",
          "uuid": "text",
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "lastUpdateTime": "2026-03-02T16:38:16.642Z",
          "triggerMethods": {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": {
              "id": "text",
              "uuid": "text",
              "name": "text",
              "description": "text",
              "status": "ACTIVE",
              "lastUpdateTime": "2026-03-02T16:38:16.642Z",
              "triggerMethods": "[Circular Reference]",
              "versions": "[Circular Reference]"
            },
            "versions": [
              "[Circular Reference]"
            ]
          },
          "versions": "[Circular Reference]"
        }
      ]
    },
    "versions": [
      {
        "id": "text",
        "uuid": "text",
        "name": "text",
        "description": "text",
        "status": "ACTIVE",
        "lastUpdateTime": "2026-03-02T16:38:16.642Z",
        "triggerMethods": {
          "id": "text",
          "uuid": "text",
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "lastUpdateTime": "2026-03-02T16:38:16.642Z",
          "triggerMethods": {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": "[Circular Reference]",
            "versions": "[Circular Reference]"
          },
          "versions": [
            "[Circular Reference]"
          ]
        },
        "versions": "[Circular Reference]"
      }
    ]
  }
]

Get workflow

get

Returns the configuration of a specific workflow by NQL ID. Use nqlId to filter for a specific configured workflow.

Authorizations

publicApiAuth

OAuth2clientCredentialsRequired

Token URL:

Query parameters

nqlIdstringRequired

The NQL ID of the workflow.

Example: #ExampleWorkflow

Header parameters

Sourcestring · nullableOptional

Responses

200

Workflow configuration.

application/json

idstringRequired

uuidstringRequired

namestringRequired

descriptionstringRequired

statusstring · enumRequiredPossible values:

lastUpdateTimestring · date-timeRequired

400

Bad request - invalid request, see error code for details.

application/json

401

Unauthorized - no valid authentication credentials.

403

No permission - no permission to execute workflow.

application/json

get

/api/v1/workflows/details

HTTPcURLJavaScriptPython

GET /api/v1/workflows/details?nqlId=text HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "uuid": "text",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "lastUpdateTime": "2026-03-02T16:38:16.642Z",
    "triggerMethods": {
      "id": "text",
      "uuid": "text",
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "lastUpdateTime": "2026-03-02T16:38:16.642Z",
      "triggerMethods": {
        "id": "text",
        "uuid": "text",
        "name": "text",
        "description": "text",
        "status": "ACTIVE",
        "lastUpdateTime": "2026-03-02T16:38:16.642Z",
        "triggerMethods": {
          "id": "text",
          "uuid": "text",
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "lastUpdateTime": "2026-03-02T16:38:16.642Z",
          "triggerMethods": {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": "[Circular Reference]",
            "versions": "[Circular Reference]"
          },
          "versions": [
            "[Circular Reference]"
          ]
        },
        "versions": [
          {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": {
              "id": "text",
              "uuid": "text",
              "name": "text",
              "description": "text",
              "status": "ACTIVE",
              "lastUpdateTime": "2026-03-02T16:38:16.642Z",
              "triggerMethods": {
                "id": "text",
                "uuid": "text",
                "name": "text",
                "description": "text",
                "status": "ACTIVE",
                "lastUpdateTime": "2026-03-02T16:38:16.642Z",
                "triggerMethods": "[Circular Reference]",
                "versions": "[Circular Reference]"
              },
              "versions": [
                "[Circular Reference]"
              ]
            },
            "versions": "[Circular Reference]"
          }
        ]
      },
      "versions": [
        {
          "id": "text",
          "uuid": "text",
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "lastUpdateTime": "2026-03-02T16:38:16.642Z",
          "triggerMethods": {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": {
              "id": "text",
              "uuid": "text",
              "name": "text",
              "description": "text",
              "status": "ACTIVE",
              "lastUpdateTime": "2026-03-02T16:38:16.642Z",
              "triggerMethods": "[Circular Reference]",
              "versions": "[Circular Reference]"
            },
            "versions": [
              "[Circular Reference]"
            ]
          },
          "versions": "[Circular Reference]"
        }
      ]
    },
    "versions": [
      {
        "id": "text",
        "uuid": "text",
        "name": "text",
        "description": "text",
        "status": "ACTIVE",
        "lastUpdateTime": "2026-03-02T16:38:16.642Z",
        "triggerMethods": {
          "id": "text",
          "uuid": "text",
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "lastUpdateTime": "2026-03-02T16:38:16.642Z",
          "triggerMethods": {
            "id": "text",
            "uuid": "text",
            "name": "text",
            "description": "text",
            "status": "ACTIVE",
            "lastUpdateTime": "2026-03-02T16:38:16.642Z",
            "triggerMethods": "[Circular Reference]",
            "versions": "[Circular Reference]"
          },
          "versions": [
            "[Circular Reference]"
          ]
        },
        "versions": "[Circular Reference]"
      }
    ]
  }
]