Automations

Download AsyncAPI spec

Run ended

The run ended event will be published when an automation execution has ended.

Payload

object
  • idstring
    Required

    Identifies the event.

    minLength = 1

  • timestring

    Timestamp of when the occurrence happened. Must adhere to RFC 3339.

    minLength = 1, format = "date-time"

  • typestring
    Required

    Unique identifier for the event type.

    default = "com.qlik.v1.automation.run.ended"

  • sourcestring
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference", default = "com.qlik/automations"

  • specversionstring
    Required

    The version of the CloudEvents specification which the event uses.

    minLength = 1

  • datacontenttypestring

    Content type of the data value. Must adhere to RFC 2046 format.

    minLength = 1, default = "application/json"

  • useridstring

    Unique identifier for the user triggering the event

  • tenantidstring
    Required

    Unique identifier for the tenant related to the event.

  • dataobject
    Show data properties
    • automationany
    • idstring

      format = "uuid"

    • titlestring
    • statusstring

      Can be one of: "exceeded limit""failed""finished""finished with warnings""must stop""not started""queued""running""starting""stopped"

    • contextstring

      The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for examples, The "test_run" context will not process all results when listing items).

      Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"

    • metricsobject
      Show metrics properties
      • blocksarray of objects

        List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks

        Show blocks properties
        • typestring
          Required

          Type of the block.

          Can be one of: "snippetBlock""endpointBlock"

        • rxBytesinteger
          Required

          Total amount of received bytes sent by the current block.

        • txBytesinteger
          Required

          Total amount of sent bytes sent by the current block.

        • apiCallsinteger

          API calls to external resources made by the current block.

        • snippetIdstring

          Unique identifier for the snippet block used within the execution.

          format = "uuid"

        • endpointIdstring

          Unique identifier for the snippet block used within the execution.

          format = "uuid"

        • connectorIdstring

          Unique identifier for the connector used within the block of the execution.

          format = "uuid"

      • networkobject
        Show network properties
        • rxBytesinteger

          The number of received bytes.

          default = 0, default = 0

        • txBytesinteger

          The number of received bytes.

          default = 0, default = 0

      • totalApiCallsinteger

        The number of API calls made.

        default = 0, default = 0

    • billableboolean

      Indicates if this automation run is billable (if there are executed blocks that are linked to billable connectors)

    • stopTimestring

      format = "date-time"

    • createdAtstring

      format = "date-time"

    • isTestRunboolean
    • startTimestring

      format = "date-time"

    • updatedAtstring

      format = "date-time"

    • isArchivedboolean
    • executedByIdstring

      Id of the executer of the affected resource.

    • scheduledStartTimestring

      format = "date-time"

    • blocksarray of objects

      List of blocks used during execution.

      Show blocks properties
      • typestring

        Type of the block.

        Can be one of: "snippetBlock""endpointBlock""baseBlock"

      • paramsarray

        Parameters of the block (only present for base blocks)

      • rxBytesinteger

        Total amount of received bytes sent by the current block.

      • txBytesinteger

        Total amount of sent bytes sent by the current block.

      • apiCallsinteger

        API calls to external resources made by the current block.

      • durationinteger

        Duration of the block execution

      • blockNamestring

        Name of the block (only present for base blocks)

      • snippetIdstring

        Unique identifier for the snippet block used within the execution.

        format = "uuid"

      • endpointIdstring

        Unique identifier for the endpoint.

        format = "uuid"

      • connectorIdstring

        Unique identifier for the connector used within the block of the execution.

        format = "uuid"

    • networkobject
      Show network properties
      • rxBytesinteger

        The number of received bytes.

        default = 0, default = 0

      • txBytesinteger

        The number of received bytes.

        default = 0, default = 0

    • totalApiCallsinteger

      The number of API calls made.
  • toplevelresourceidstring

    Unique identifier for the automation that has just started a single execution.

com.qlik.v1.automation.run.ended

Example payload of the "Run ended" event

{
  "id": "A234-1234-1234",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.automation.run.ended",
  "source": "com.qlik/automations",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "userid": "00000000-0000-0000-0000-000000000000",
  "tenantid": "00000000-0000-0000-0000-000000000000",
  "data": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "title": "string",
    "status": "exceeded limit",
    "context": "test_run",
    "metrics": {
      "blocks": [
        {
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "apiCalls": 40,
          "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "billable": false,
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "isTestRun": true,
    "startTime": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z",
    "isArchived": true,
    "executedById": "00000000-0000-0000-0000-000000000000",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
    "blocks": [
      {
        "type": "endpointBlock",
        "params": [],
        "rxBytes": 18329921,
        "txBytes": 18329921,
        "apiCalls": 40,
        "duration": 1000,
        "blockName": "SleepBlock",
        "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
      }
    ],
    "network": {
      "rxBytes": 0,
      "txBytes": 0
    },
    "totalApiCalls": 42
  },
  "toplevelresourceid": "00000000-0000-0000-0000-000000000000"
}