v3

latestSwagger 2.02026-08-067506752.0 MB
action

Run an action - for testing

post/v1/org/{orgId}/action/{actionId}/run

Path parameters

orgIdstring required

Org identifier (either id or slug)

actionIdstring required

Action id

Request body

jobIdstring
eventIdstring
eventCodestring

Example request

{
  "jobId": "588f7ee98f138b19220041a7",
  "eventId": "588f7ee98f138b19220041a7",
  "action": {
    "id": "588f7ee98f138b19220041a7",
    "orgId": "588f7ee98f138b19220041a7",
    "cronSchedule": "5 4 * * *",
    "steps": [
      {
        "stepId": "588f7ee98f138b19220041a7",
        "formId": "588f7ee98f138b19220041a7",
        "templateId": "588f7ee98f138b19220041a7",
        "aiAgentUserId": "588f7ee98f138b19220041a7",
        "aiApprovedPolicyRules": [
          {
            "departmentIds": [
              "588f7ee98f138b19220041a7"
            ],
            "filter": "department:engineering and under:me",
            "targets": [
              {
                "personId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ]
      }
    ],
    "runUserId": "588f7ee98f138b19220041a7",
    "categoryId": "588f7ee98f138b19220041a7",
    "assessmentId": "588f7ee98f138b19220041a7",
    "formId": "588f7ee98f138b19220041a7",
    "createId": "588f7ee98f138b19220041a7",
    "createBehalfId": "588f7ee98f138b19220041a7",
    "createAttribution": {
      "principalUserId": "588f7ee98f138b19220041a7",
      "agentUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "eventId": "588f7ee98f138b19220041a7",
      "aiChatId": "588f7ee98f138b19220041a7"
    },
    "createAt": "2017-01-24T13:57:52Z",
    "updateId": "588f7ee98f138b19220041a7",
    "updateBehalfId": "588f7ee98f138b19220041a7",
    "updateAttribution": {
      "principalUserId": "588f7ee98f138b19220041a7",
      "agentUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "eventId": "588f7ee98f138b19220041a7",
      "aiChatId": "588f7ee98f138b19220041a7"
    },
    "updateAt": "2017-01-24T13:57:52Z",
    "deleteId": "588f7ee98f138b19220041a7",
    "deleteBehalfId": "588f7ee98f138b19220041a7",
    "deleteAttribution": {
      "principalUserId": "588f7ee98f138b19220041a7",
      "agentUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "eventId": "588f7ee98f138b19220041a7",
      "aiChatId": "588f7ee98f138b19220041a7"
    },
    "deleteAt": "2017-01-24T13:57:52Z"
  }
}

Response

successful operation