Workflow

Get details of a workflow.

Get the details of a workflow identified by its id.

get/api/v2/workflows/{id}

Request

Base URL
https://app.blackkitetech.com
Auth
OAuth 2
Client credentials
Token URLhttps://app.blackkitetech.com//api/v2/oauth/token
TypeScript
https://skmtc.dev/blackkitetech/apis/black-kite-api/docs/api/v2/workflows/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

The id of the workflow requested.

Success

WorkflowIdinteger required

The unique identifier of this workflow.

Orderinteger

The order of this workflow.

Namestring

The name of this workflow.

ActionType'NotifyByEmail' | 'NotifyBySms' | 'UpdateFindingStatus' | 'OpenTicket' | 'Webhook'

The action type of this workflow.

Status'Active' | 'Inactive'

The current status of this workflow.

{
  "WorkflowId": 45,
  "Order": 1,
  "Name": "My Workflow",
  "ActionType": "NotifyByEmail",
  "Status": "Active"
}

No recorded changes to this operation across all 8 revisions of this API.