Reloads

Download AsyncAPI spec

Reload events notify subscribers about reload-related activity in Qlik Cloud.

For most use cases, subscribe to com.qlik.v1.reload.finished. This event is emitted when a scheduled reload or a reload request started through the Reloads API has completed and the final outcome is known. Use this event to trigger downstream pipelines, send notifications, run reports, or start reload sequences that depend on the confirmed result of a reload.

Use com.qlik.v1.app.reload.finished only when you need to react to individual engine reload attempts, including attempts that might be retried before the final reload result is known.

Use com.qlik.v1.app.data.updated when your workflow depends on app data or app content being updated, rather than on the final status of a reload request.

Reload Finished Event

The reload finished event will be published when a reload has finished. While a reload might be executed multiple times, there will be only one reload finished event.

Payload

object
  • id string
    Required

    Unique identifier for the event.

    minLength = 1

  • host string

    The host of the event.

  • time string

    Timestamp of when the event happened.

    format = "date-time"

  • type string
    Required

    Unique identifier for the event type.

    default = "com.qlik.v1.reload.finished"

  • source string
    Required

    The source of the event.

    default = "com.qlik/reloads"

  • ownerid string

    The owner ID of the event.

  • originip string

    The origin IP of the event.

  • specversion string
    Required

    The event is compatible with the CloudEvents specification v1.0.

    Can be one of: "1.0"

    default = "1.0"

  • datacontenttype string

    The content type of the event payload.

    default = "application/json"

  • reason string

    Reason the event was triggered.

  • userid string

    Unique identifier for the user related to the event.

  • spaceid string

    Unique identifier for the space related to the event.

  • authtype string

    Representing the type of principal that triggered the occurrence.

  • clientid string

    Unique identifier for the client related to the event.

  • tenantid string
    Required

    Unique identifier for the tenant related to the event.

  • sessionid string

    The session ID of the event.

  • authclaims string

    A JSON string representing claims of the principal that triggered the event

  • tracestate string

    A comma-delimited list of key-value pairs.

  • traceparent string

    Contains a version, trace ID, span ID, and trace options.

  • toplevelresourceid string

    Unique identifier for top level resource related to the event.

  • data object

    Data specific to the reload finished event.

    Show data properties
    • id string
      Required

      Reload ID.

    • type string

      What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.

      Can be one of: "hub""chronos""external""automations""data-refresh""choreographer"

    • appId string
      Required

      ID of the reloaded app.

    • status string

      The end status of reload.

      Can be one of: "SUCCEEDED""FAILED""CANCELED""EXCEEDED_LIMIT"

    • taskId string

      ID of the app's scheduled reload task.

    • userId string
      Required

      ID of the requesting user.

    • weight integer

      The weight of the reload. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.

      minimum = 1, maximum = 10, default = 1, default = 1

    • partial boolean

      The partial status of reload.

    • appUsage string

      The app's usage type

    • tenantId string

      ID of the tenant.

    • errorCode string

      Error code, if failed.

    • startTime string

      Reload starting time from engine.

      format = "date-time"

    • succeeded boolean
      Required

      Success status of reload.

    • resourceId string

      Identifies the specific resource ID within that service.

    • creationTime string

      Reload creation time.

      format = "date-time"

    • errorMessage string

      Error message, if failed.

    • resourceType string

      Identifies the service type that triggered the reload, e.g. "api".

    • licenseNumber string

      License number from the requesting user's JWT.

    • enginePoolName string

      The engine pool that executed the reload.

    • lastReloadTime string

      Last reload time from engine, if succeeded.

      format = "date-time"

    • durationSeconds number

      Duration from engine session acquisition to reload attempt completion (seconds).

    • requeueCounters object

      The number of times the reload has been requeued, and the number of those requeues caused by errors (such as a websocket error).

      Show requeueCounters properties
      • requeuesTotal integer

        Total number of times the reload has been requeued.

        minimum = 0

      • requeuesWithErrors integer

        Number of times the reload has been requeued due to an error.

        minimum = 0

    • reloadPacksFactor number

      Reload packs factor determined by the engine size used for the reload.

      default = 0, default = 0

    • engineSizingReason string

      Reason used to determine the engine size for the reload.

    • reloadPacksConsumed integer

      Number of reload packs consumed by the reload. Only populated when the reload packs feature is enabled for the tenant.

      default = 0, default = 0

    • reloadComputeConsumed integer

      Amount of compute consumed by the reload.

      default = 0, default = 0

    • crashedOnMaxSizeEngine boolean

      Whether the session request failed due to the app previously crashing on a max size engine

com.qlik.v1.reload.finished

Example payload of the "Reload Finished Event" event

{
  "id": "b347fd0d-1321-417f-91ee-90e96c76389c",
  "host": "qlik.example.com",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.reload.finished",
  "source": "com.qlik/reloads",
  "ownerid": "5be59decca62aa00097268a4",
  "originip": "192.168.1.1",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "reason": "User initiated reload",
  "userid": "5be59decca62aa00097268a4",
  "spaceid": "64db65d5970c28d340790f5c",
  "authtype": "token",
  "clientid": "id123",
  "tenantid": "UkeLb6ICti8OA8f3LueRI5kVNtuHc15f",
  "sessionid": "b1fb457e-fca4-3c7d-8436-14380a990aef",
  "authclaims": "{\"sub\":\"5be59decca62aa00097268a4\",\"name\":\"John Doe\",\"email\":\"john.doe@example.com\"}",
  "tracestate": "key1=value1,key2=value2",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "toplevelresourceid": "002ff8c5-3c11-4464-a22b-68fb5e7ee5e8",
  "data": {
    "id": "6a849f7f18ec290e6ceb025d",
    "appId": "002ff8c5-3c11-4464-a22b-68fb5e7ee5e8",
    "userId": "5be59decca62aa00097268a4",
    "succeeded": true
  }
}