Trigger a Workflow to Run

Use this API to run a Workflow.

post/workflows/{id}

Request

Base URL
https://client.apimetrics.io/api/2
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/apicontext/apis/api-settings/docs/workflows/:id/post~2.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

ID of Workflow you're triggering

Request body

location_idstring

Location where the API Call was made.

contextstring

Dictionary of variable names and their values

Response

200

workflow_idstring

workflow_result_idstring

location_idstring

Example response

{
  "workflow_id": "agxkZXZ-dmlhdGVzdHNyGgsSDVRlc3RSdW5SZXN1bHQYgICAgKCvlwoM",
  "workflow_result_id": "agxkZXZ-dmlhdGVzdHNyFAsSB1Rlc3RSdW4YgICAgKCPnwoM",
  "context": {
    "FOO": 1234,
    "BAR": "%%RESULT_ID%%",
    "DATUM": "%%DATETIME%%"
  }
}

Changes

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