Task created

Published when a new task is created. The event includes the task ID, owner, associated resource, and the scheduled action.

Payload

object
  • id string
    Required

    Identifies the event.

  • time string

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

  • type string
    Required

    The specific event type for this message.

    Can be one of: "com.qlik.scheduling.task.created"

  • source string
    Required

    Identifies the context in which an event happened.

  • specversion string
    Required

    The version of the CloudEvents specification which the event uses.

  • datacontenttype string

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

  • userid string

    Unique identifier of the user related to the event.

  • ownerid string

    Unique identifier of the task owner. Falls back to the task creator when no distinct owner is set.

  • tenantid string

    Unique identifier of the tenant related to the event.

  • toplevelresourceid string

    Identifier of the top-level resource that triggered the event.

  • data object

    Represents the full state of a task resource at the time the event was published. All lifecycle events carry this object as their data payload, capturing the task's configuration, ownership, and execution status.

    Show data properties
    • id string
      Required

      The unique identifier of the task.

    • name string
      Required

      The name of the task.

    • _meta object

      Internal task metadata, emitted as-is. Not part of the stable public contract for other properties in this document; fields may be added.

      Show _meta properties
      • usage string

        The product domain in which the resource is used.

      • ownerId string

        The user ID of the task owner.

      • spaceId string

        The unique identifier of the space the task operates in.

      • trigger object
        Show trigger properties
        • id string

          The unique identifier of the trigger associated with this task.

        • type integer

          The type identifier of the trigger associated with this task.

      • tenantId string

        The unique identifier of the tenant the task operates in.

      • topology object

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChild boolean

          When true, this task is triggered by one or more parent tasks.

        • isParent boolean

          When true, this task has one or more downstream dependent tasks.

      • createdAt string

        The UTC timestamp when the task was created.

      • createdBy string

        The user ID of the user who created the task.

      • deletedAt string

        The UTC timestamp when the task was deleted.

      • spaceType string

        The type of space the task operates in.

      • updatedAt string

        The UTC timestamp when the task was last updated.

      • disabledCode string

        The reason the task is currently disabled.

      • migratedFrom string

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceName string

        The name of the resource on which the task was created.

      • resourceType string

        The type of resource on which the task was created.

      • orchestration object
        Show orchestration properties
        • id string

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • type integer

          The type identifier of the orchestration system handling this task.

        • attrs object

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • string string
        • lastRun object
          Show lastRun properties
          • id string

            The unique identifier of the task run.

          • status string

            The current status of the task run.

          • endedAt string

            The UTC timestamp when the task run ended.

          • workerId string

            The unique identifier of the worker that executed the job.

          • startedAt string

            The UTC timestamp when the task run started.

          • executedAs string

            The user ID of the user on whose behalf the task was executed.

          • workerType string

            The type or name of the target system that executed the run.

          • triggeredBy string

            The identity or event that triggered the task run.

      • scriptOwnerId string

        The user ID of the owner whose script context is used when running the task.

      • resourceSubType string

        The subtype of resource on which the task was created.

    • usage string

      The product domain in which the associated resource is used. Always present on the wire; empty when not specified (the product treats a missing value as ANALYTICS, but this event does not apply that default itself).

      Can be one of: """ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • action string
      Required

      The action performed on the target resource.

    • status string

      The outcome of the operation this event reports, not a run's final status specifically. Set by the publisher for every event type, not only task.run.finished.

      Can be one of: "SUCCEEDED""FAILED""ABORTED"

    • enabled boolean

      Whether the task is enabled. When true, the task is active and eligible to run.

    • ownerId string
      Required

      The unique identifier of the user that owns the task. Only applicable for user-level tasks.

    • spaceId string

      The unique identifier of the space the task operates in.

    • createdAt string

      The UTC timestamp when the task was created. Always present; carries the zero timestamp 0001-01-01T00:00:00Z when the task has no recorded creation time.

    • createdBy string
      Required

      The unique identifier of the user that created the task.

    • updatedAt string

      The UTC timestamp when the task was last updated. Always present; carries the zero timestamp 0001-01-01T00:00:00Z when the task has no recorded update time.

    • resourceId string
      Required

      The unique identifier of the target resource associated with the task's action.

    • description string

      A user-provided description of the task.

    • actionParams object

      The parameters for the action, as an object of arbitrary JSON-valued properties (strings, numbers, booleans, nested objects/arrays, or null).

    • disabledCode string

      The reason the task was disabled. Always present; empty when the task is not disabled.

      Can be one of: """MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"

    • migratedFrom string

      The identifier of the original reload task from which this task was migrated. Empty if the task was not migrated.

    • resourceType string
      Required

      The type of resource the task operates on.

      Can be one of: "app"

    • statusDetails string

      Additional details about the final status, such as the failure reason, automation ID, or reload ID.

com.qlik.scheduling.task.created

Example payload of the "Task created" event

{
"id": "A234-1234-1234",
"time": "2018-10-30T07:06:22Z",
"type": "com.qlik.scheduling.task.created",
"source": "com.qlik/choreographer",
"specversion": "1.0",
"datacontenttype": "application/json",
"userid": "ad378d54-3e97-47c0-bc57-cd84dbb93fa2",
"ownerid": "22222222-2222-2222-2222-222222222222",
"tenantid": "103359ca-3579-4125-a0dc-d19531b53186",
"toplevelresourceid": "11111111-1111-1111-1111-111111111111",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "My task",
"_meta": {
"usage": "string",
"ownerId": "string",
"spaceId": "string",
"trigger": {
"id": "string",
"type": 42
},
"tenantId": "string",
"topology": {
"isChild": true,
"isParent": true
},
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "string",
"deletedAt": "2018-10-30T07:06:22Z",
"spaceType": "string",
"updatedAt": "2018-10-30T07:06:22Z",
"disabledCode": "string",
"migratedFrom": "string",
"resourceName": "string",
"resourceType": "string",
"orchestration": {
"id": "string",
"type": 42,
"attrs": {},
"lastRun": {
"id": "string",
"status": "string",
"endedAt": "2018-10-30T07:06:22Z",
"workerId": "string",
"startedAt": "2018-10-30T07:06:22Z",
"executedAs": "string",
"workerType": "string",
"triggeredBy": "string"
}
},
"scriptOwnerId": "string",
"resourceSubType": "string"
},
"usage": "",
"action": "string",
"status": "SUCCEEDED",
"enabled": true,
"ownerId": "00000000-0000-0000-0000-000000000000",
"spaceId": "string",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2018-10-30T07:06:22Z",
"resourceId": "string",
"description": "This is my task",
"actionParams": {},
"disabledCode": "",
"migratedFrom": "string",
"resourceType": "app",
"statusDetails": "string"
}
}

Task deleted

Published when a task is deleted. The event includes the task state at the time of deletion, including the task ID and owner.

Payload

object
  • id string
    Required

    Identifies the event.

  • time string

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

  • type string
    Required

    The specific event type for this message.

    Can be one of: "com.qlik.scheduling.task.deleted"

  • source string
    Required

    Identifies the context in which an event happened.

  • specversion string
    Required

    The version of the CloudEvents specification which the event uses.

  • datacontenttype string

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

  • userid string

    Unique identifier of the user related to the event.

  • ownerid string

    Unique identifier of the task owner. Falls back to the task creator when no distinct owner is set.

  • tenantid string

    Unique identifier of the tenant related to the event.

  • toplevelresourceid string

    Identifier of the top-level resource that triggered the event.

  • data object

    Represents the full state of a task resource at the time the event was published. All lifecycle events carry this object as their data payload, capturing the task's configuration, ownership, and execution status.

    Show data properties
    • id string
      Required

      The unique identifier of the task.

    • name string
      Required

      The name of the task.

    • _meta object

      Internal task metadata, emitted as-is. Not part of the stable public contract for other properties in this document; fields may be added.

      Show _meta properties
      • usage string

        The product domain in which the resource is used.

      • ownerId string

        The user ID of the task owner.

      • spaceId string

        The unique identifier of the space the task operates in.

      • trigger object
        Show trigger properties
        • id string

          The unique identifier of the trigger associated with this task.

        • type integer

          The type identifier of the trigger associated with this task.

      • tenantId string

        The unique identifier of the tenant the task operates in.

      • topology object

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChild boolean

          When true, this task is triggered by one or more parent tasks.

        • isParent boolean

          When true, this task has one or more downstream dependent tasks.

      • createdAt string

        The UTC timestamp when the task was created.

      • createdBy string

        The user ID of the user who created the task.

      • deletedAt string

        The UTC timestamp when the task was deleted.

      • spaceType string

        The type of space the task operates in.

      • updatedAt string

        The UTC timestamp when the task was last updated.

      • disabledCode string

        The reason the task is currently disabled.

      • migratedFrom string

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceName string

        The name of the resource on which the task was created.

      • resourceType string

        The type of resource on which the task was created.

      • orchestration object
        Show orchestration properties
        • id string

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • type integer

          The type identifier of the orchestration system handling this task.

        • attrs object

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • string string
        • lastRun object
          Show lastRun properties
          • id string

            The unique identifier of the task run.

          • status string

            The current status of the task run.

          • endedAt string

            The UTC timestamp when the task run ended.

          • workerId string

            The unique identifier of the worker that executed the job.

          • startedAt string

            The UTC timestamp when the task run started.

          • executedAs string

            The user ID of the user on whose behalf the task was executed.

          • workerType string

            The type or name of the target system that executed the run.

          • triggeredBy string

            The identity or event that triggered the task run.

      • scriptOwnerId string

        The user ID of the owner whose script context is used when running the task.

      • resourceSubType string

        The subtype of resource on which the task was created.

    • usage string

      The product domain in which the associated resource is used. Always present on the wire; empty when not specified (the product treats a missing value as ANALYTICS, but this event does not apply that default itself).

      Can be one of: """ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • action string
      Required

      The action performed on the target resource.

    • status string

      The outcome of the operation this event reports, not a run's final status specifically. Set by the publisher for every event type, not only task.run.finished.

      Can be one of: "SUCCEEDED""FAILED""ABORTED"

    • enabled boolean

      Whether the task is enabled. When true, the task is active and eligible to run.

    • ownerId string
      Required

      The unique identifier of the user that owns the task. Only applicable for user-level tasks.

    • spaceId string

      The unique identifier of the space the task operates in.

    • createdAt string

      The UTC timestamp when the task was created. Always present; carries the zero timestamp 0001-01-01T00:00:00Z when the task has no recorded creation time.

    • createdBy string
      Required

      The unique identifier of the user that created the task.

    • updatedAt string

      The UTC timestamp when the task was last updated. Always present; carries the zero timestamp 0001-01-01T00:00:00Z when the task has no recorded update time.

    • resourceId string
      Required

      The unique identifier of the target resource associated with the task's action.

    • description string

      A user-provided description of the task.

    • actionParams object

      The parameters for the action, as an object of arbitrary JSON-valued properties (strings, numbers, booleans, nested objects/arrays, or null).

    • disabledCode string

      The reason the task was disabled. Always present; empty when the task is not disabled.

      Can be one of: """MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"

    • migratedFrom string

      The identifier of the original reload task from which this task was migrated. Empty if the task was not migrated.

    • resourceType string
      Required

      The type of resource the task operates on.

      Can be one of: "app"

    • statusDetails string

      Additional details about the final status, such as the failure reason, automation ID, or reload ID.

com.qlik.scheduling.task.deleted

Example payload of the "Task deleted" event

{
"id": "A234-1234-1234",
"time": "2018-10-30T07:06:22Z",
"type": "com.qlik.scheduling.task.deleted",
"source": "com.qlik/choreographer",
"specversion": "1.0",
"datacontenttype": "application/json",
"userid": "ad378d54-3e97-47c0-bc57-cd84dbb93fa2",
"ownerid": "22222222-2222-2222-2222-222222222222",
"tenantid": "103359ca-3579-4125-a0dc-d19531b53186",
"toplevelresourceid": "11111111-1111-1111-1111-111111111111",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "My task",
"_meta": {
"usage": "string",
"ownerId": "string",
"spaceId": "string",
"trigger": {
"id": "string",
"type": 42
},
"tenantId": "string",
"topology": {
"isChild": true,
"isParent": true
},
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "string",
"deletedAt": "2018-10-30T07:06:22Z",
"spaceType": "string",
"updatedAt": "2018-10-30T07:06:22Z",
"disabledCode": "string",
"migratedFrom": "string",
"resourceName": "string",
"resourceType": "string",
"orchestration": {
"id": "string",
"type": 42,
"attrs": {},
"lastRun": {
"id": "string",
"status": "string",
"endedAt": "2018-10-30T07:06:22Z",
"workerId": "string",
"startedAt": "2018-10-30T07:06:22Z",
"executedAs": "string",
"workerType": "string",
"triggeredBy": "string"
}
},
"scriptOwnerId": "string",
"resourceSubType": "string"
},
"usage": "",
"action": "string",
"status": "SUCCEEDED",
"enabled": true,
"ownerId": "00000000-0000-0000-0000-000000000000",
"spaceId": "string",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2018-10-30T07:06:22Z",
"resourceId": "string",
"description": "This is my task",
"actionParams": {},
"disabledCode": "",
"migratedFrom": "string",
"resourceType": "app",
"statusDetails": "string"
}
}

Task updated

Published when a task's configuration or properties are updated. The event includes the updated task state along with a list of changed fields in _updates, identifying what was modified and the old and new values. Use this to detect configuration drift or audit changes to scheduled tasks.

Payload

object
  • id string
    Required

    Identifies the event.

  • time string

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

  • type string
    Required

    The specific event type for this message.

    Can be one of: "com.qlik.scheduling.task.updated"

  • source string
    Required

    Identifies the context in which an event happened.

  • specversion string
    Required

    The version of the CloudEvents specification which the event uses.

  • datacontenttype string

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

  • userid string

    Unique identifier of the user related to the event.

  • ownerid string

    Unique identifier of the task owner. Falls back to the task creator when no distinct owner is set.

  • tenantid string

    Unique identifier of the tenant related to the event.

  • toplevelresourceid string

    Identifier of the top-level resource that triggered the event.

  • data object

    Represents the full state of a task resource at the time the event was published. All lifecycle events carry this object as their data payload, capturing the task's configuration, ownership, and execution status.

    Show data properties
    • id string
      Required

      The unique identifier of the task.

    • name string
      Required

      The name of the task.

    • _meta object

      Internal task metadata, emitted as-is. Not part of the stable public contract for other properties in this document; fields may be added.

      Show _meta properties
      • usage string

        The product domain in which the resource is used.

      • ownerId string

        The user ID of the task owner.

      • spaceId string

        The unique identifier of the space the task operates in.

      • trigger object
        Show trigger properties
        • id string

          The unique identifier of the trigger associated with this task.

        • type integer

          The type identifier of the trigger associated with this task.

      • tenantId string

        The unique identifier of the tenant the task operates in.

      • topology object

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChild boolean

          When true, this task is triggered by one or more parent tasks.

        • isParent boolean

          When true, this task has one or more downstream dependent tasks.

      • createdAt string

        The UTC timestamp when the task was created.

      • createdBy string

        The user ID of the user who created the task.

      • deletedAt string

        The UTC timestamp when the task was deleted.

      • spaceType string

        The type of space the task operates in.

      • updatedAt string

        The UTC timestamp when the task was last updated.

      • disabledCode string

        The reason the task is currently disabled.

      • migratedFrom string

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceName string

        The name of the resource on which the task was created.

      • resourceType string

        The type of resource on which the task was created.

      • orchestration object
        Show orchestration properties
        • id string

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • type integer

          The type identifier of the orchestration system handling this task.

        • attrs object

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • string string
        • lastRun object
          Show lastRun properties
          • id string

            The unique identifier of the task run.

          • status string

            The current status of the task run.

          • endedAt string

            The UTC timestamp when the task run ended.

          • workerId string

            The unique identifier of the worker that executed the job.

          • startedAt string

            The UTC timestamp when the task run started.

          • executedAs string

            The user ID of the user on whose behalf the task was executed.

          • workerType string

            The type or name of the target system that executed the run.

          • triggeredBy string

            The identity or event that triggered the task run.

      • scriptOwnerId string

        The user ID of the owner whose script context is used when running the task.

      • resourceSubType string

        The subtype of resource on which the task was created.

    • usage string

      The product domain in which the associated resource is used. Always present on the wire; empty when not specified (the product treats a missing value as ANALYTICS, but this event does not apply that default itself).

      Can be one of: """ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • action string
      Required

      The action performed on the target resource.

    • status string

      The outcome of the operation this event reports, not a run's final status specifically. Set by the publisher for every event type, not only task.run.finished.

      Can be one of: "SUCCEEDED""FAILED""ABORTED"

    • enabled boolean

      Whether the task is enabled. When true, the task is active and eligible to run.

    • ownerId string
      Required

      The unique identifier of the user that owns the task. Only applicable for user-level tasks.

    • spaceId string

      The unique identifier of the space the task operates in.

    • createdAt string

      The UTC timestamp when the task was created. Always present; carries the zero timestamp 0001-01-01T00:00:00Z when the task has no recorded creation time.

    • createdBy string
      Required

      The unique identifier of the user that created the task.

    • updatedAt string

      The UTC timestamp when the task was last updated. Always present; carries the zero timestamp 0001-01-01T00:00:00Z when the task has no recorded update time.

    • resourceId string
      Required

      The unique identifier of the target resource associated with the task's action.

    • description string

      A user-provided description of the task.

    • actionParams object

      The parameters for the action, as an object of arbitrary JSON-valued properties (strings, numbers, booleans, nested objects/arrays, or null).

    • disabledCode string

      The reason the task was disabled. Always present; empty when the task is not disabled.

      Can be one of: """MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"

    • migratedFrom string

      The identifier of the original reload task from which this task was migrated. Empty if the task was not migrated.

    • resourceType string
      Required

      The type of resource the task operates on.

      Can be one of: "app"

    • statusDetails string

      Additional details about the final status, such as the failure reason, automation ID, or reload ID.

    • _updates array of objects

      The list of fields updated in this task, with the old and new values for each changed field.

      Show _updates properties
      • path string

        The name of the top-level task field that changed, as produced by a JSON merge-patch diff between the previous and updated task. Not a JSON Pointer or a recursive path expression.

      • newValue any

        The new value of the field after the update. Any JSON value, including null.

      • oldValue any

        The previous value of the field before the update. Any JSON value, including null.

com.qlik.scheduling.task.updated

Example payload of the "Task updated" event

{
"id": "A234-1234-1234",
"time": "2018-10-30T07:06:22Z",
"type": "com.qlik.scheduling.task.updated",
"source": "com.qlik/choreographer",
"specversion": "1.0",
"datacontenttype": "application/json",
"userid": "ad378d54-3e97-47c0-bc57-cd84dbb93fa2",
"ownerid": "22222222-2222-2222-2222-222222222222",
"tenantid": "103359ca-3579-4125-a0dc-d19531b53186",
"toplevelresourceid": "11111111-1111-1111-1111-111111111111",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "My task",
"_meta": {
"usage": "string",
"ownerId": "string",
"spaceId": "string",
"trigger": {
"id": "string",
"type": 42
},
"tenantId": "string",
"topology": {
"isChild": true,
"isParent": true
},
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "string",
"deletedAt": "2018-10-30T07:06:22Z",
"spaceType": "string",
"updatedAt": "2018-10-30T07:06:22Z",
"disabledCode": "string",
"migratedFrom": "string",
"resourceName": "string",
"resourceType": "string",
"orchestration": {
"id": "string",
"type": 42,
"attrs": {},
"lastRun": {
"id": "string",
"status": "string",
"endedAt": "2018-10-30T07:06:22Z",
"workerId": "string",
"startedAt": "2018-10-30T07:06:22Z",
"executedAs": "string",
"workerType": "string",
"triggeredBy": "string"
}
},
"scriptOwnerId": "string",
"resourceSubType": "string"
},
"usage": "",
"action": "string",
"status": "SUCCEEDED",
"enabled": true,
"ownerId": "00000000-0000-0000-0000-000000000000",
"spaceId": "string",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2018-10-30T07:06:22Z",
"resourceId": "string",
"description": "This is my task",
"actionParams": {},
"disabledCode": "",
"migratedFrom": "string",
"resourceType": "app",
"statusDetails": "string",
"_updates": [
{
"path": "string"
}
]
}
}