Get Workflow Activities

Changed on

Returns the audit log of actions a workflow has actually executed (e.g. a job created/updated as a result of a rule firing) — distinct from the workflow's own configuration.

get/workflow/activities

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/workflow/activities
  • Auth
    API key in header x-api-key

Query parameters

pageinteger
countinteger
sort'"ASC"' | '"DESC"'
sort_by'"type"' | '"created_at"'
filter.action_modulestring
filter.workflowstring
filter.typestring

Response

200

typestring
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "activity_uid": "11ca7040-8988-11ec-801b-03e0ad8587cd",
      "workflow": {
        "workflow_name": "SKYC - Gujarat Store",
        "workflow_description": "Gujarat Store",
        "workflow_uid": "681c03f0-88d9-11ec-be25-67cf7f623b46",
        "trigger_module": "JOB",
        "workflow_access": "COMPANY_WIDE",
        "trigger_event": "job.new",
        "trigger_event_name": "New Job",
        "is_active": true,
        "created_at": "2022-02-08T12:19:47.774Z"
      },
      "created_at": "2022-02-09T09:10:04.868Z",
      "updated_at": "2022-02-09T09:10:04.871Z",
      "id": "undefined"
    }
  ],
  "total_records": 2,
  "current_page": 1,
  "total_pages": 1
}

Changes