HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Task events

task_metadata_modified

When any of the following properties of a task is modified:

  • Title
  • Campaign
  • Start at
  • Due at
  • Is completed
  • Is archived
  • Labels

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_metadata_modifed.
dataobjectData of the event.
data[task]objectData of the task which has been removed.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch task through Welcome Open API.

Example

{
    "event_name": "task_metadata_modified",
    "data": {
        "task": {
            "id": "870825113a12950a7eeeb64a64236dff",
            "links": {
                "self": "https://api.welcomesoftware.com/v3/tasks/870825113a12950a7eeeb64a64236dff"
            }
        }
    }
}

task_removed

When a task is removed.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_removed.
dataobjectData of the event.
data[task]objectData of the task which has been removed.
data[task][id]stringUnique identifier of the task.

Example

{
    "event_name": "task_removed",
    "data": {
        "task": {
            "id": "870825113a12950a7eeeb64a64236dff",
        }
    }
}

task_brief_added

When brief is added to a task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_brief_added.
dataobjectData of the event.
data[task]objectData of the task associated with the brief.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task.
data[task][links][self]stringURL to fetch the task through Welcome Open API
data[task][links][brief]stringURL to fetch the task brief through Welcome Open API

Example

{
    "event_name": "task_brief_added",
    "data": {
        "task": {
              "id": "3e34f1639c1046d49f51f5ab8cbb3fdf",
              "links": {
                  "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf",
                  "brief": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/brief"
              }
        }
    }
}

task_brief_removed

When brief is removed from a task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_brief_removed.
dataobjectData of the event.
data[task]objectData of the task associated with the brief.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task.
data[task][links][self]stringURL to fetch the task through Welcome Open API

Example

{
    "event_name": "task_brief_removed",
    "data": {
        "task": {
              "id": "3e34f1639c1046d49f51f5ab8cbb3fdf",
              "links": {
                  "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf"
              }
        }
    }
}

task_brief_modified

When brief of a task is modified.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_brief_modified.
dataobjectData of the event.
data[task]objectData of the task associated with the brief.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task.
data[task][links][self]stringURL to fetch the task through Welcome Open API
data[task][links][brief]stringURL to fetch the task brief through Welcome Open API

Example

{
    "event_name": "task_brief_modified",
    "data": {
        "task": {
              "id": "3e34f1639c1046d49f51f5ab8cbb3fdf",
              "links": {
                  "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf",
                  "brief": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/brief"
              }
        }
    }
}

task_asset_added

When an asset (article, image, video or raw file) is added to a Task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_asset_added.
dataobjectData of the event.
data[task]objectData of the task associated with the deleted asset.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets of the task through Welcome Open API.
data[asset]objectData of the asset associated with the event.
data[asset][id]stringUnique identifier of the asset.
data[asset][type]stringType of the asset. Value can be article, image, video or raw_file.
data[asset][links]objectLinks related to the asset
data[asset][links][self]stringURL to fetch the asset through Welcome Open API.
data[asset][links][task]stringURL to fetch the task of the asset through Welcome Open API.

Example

{
    "event_name": "task_asset_added",
    "data": {
        "task": {
            "id": "5f6a0312a5963d0591015e3e",
            "links": {
                "self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
                "assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
            }
        },
        "asset": {
            "id": "870825113a12950a7eeeb64a64236d49",
            "type": "image",
            "links": {
                "self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/images/870825113a12950a7eeeb64a64236d49",
                "task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
            }
        }
    }
}

task_asset_removed

When an asset (article, image, video or raw file) is removed from a Task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_asset_removed.
dataobjectData of the event.
data[task]objectData of the task associated with the deleted asset.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets of the task through Welcome Open API.
data[asset]objectData of the asset associated with the event.
data[asset][id]stringUnique identifier of the asset.
data[asset][type]stringType of the asset. Value can be article, image, video or raw_file.

Example

{
    "event_name": "task_asset_removed",
    "data": {
        "task": {
            "id": "5f6a0312a5963d0591015e3e",
            "links": {
                "self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
                "assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
            }
        },
        "asset": {
            "id": "870825113a12950a7eeeb64a64236d49",
            "type": "image"
        }
    }
}

task_asset_modified

When an asset (article, image, video or raw file) of a task is modified. This event will be triggered for the modification of the task asset's title, labels and versions (of image, video or raw file).

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_asset_modified.
dataobjectData of the event.
data[task]objectData of the task associated with the modified asset.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets of the task through Welcome Open API.
data[asset]objectData of the asset associated with the event.
data[asset][id]stringUnique identifier of the asset.
data[asset][type]stringType of the asset. Value can be article, image, video or raw_file.
data[asset][links]objectLinks related to the asset
data[asset][links][self]stringURL to fetch the asset through Welcome Open API.
data[asset][links][task]stringURL to fetch the task of the asset through Welcome Open API.

Example

{
    "event_name": "task_asset_modified",
    "data": {
        "task": {
            "id": "5f6a0312a5963d0591015e3e",
            "links": {
                "self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
                "assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
            }
        },
        "asset": {
            "id": "870825113a12950a7eeeb64a64236d49",
            "type": "image",
            "links": {
                "self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/images/870825113a12950a7eeeb64a64236d49",
                "task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
            }
        }
    }
}

task_asset_draft_added

When a new draft is added to an asset of a task. Currently supported asset types: image, video and raw_file.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_asset_draft_added.
dataobjectData of the event.
data[task]objectData of the task associated with the updated asset.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task.
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets of the task through Welcome Open API.
data[asset]objectData of the asset for which a new draft was added.
data[asset][id]stringUnique identifier of the asset.
data[asset][type]stringType of the asset. Value can be image, video or raw_file.
data[asset][links]objectLinks related to the asset
data[asset][links][self]stringURL to fetch the asset through Welcome Open API.
data[asset][links][task]stringURL to fetch the task of the asset through Welcome Open API.

Example

{
  "event_name": "task_asset_draft_added",
  "data": {
    "task": {
      "id":"3e34f1639c1046d49f51f5ab8cbb3fdf",
      "links":{
        "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf",
        "assets": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/assets"
      }
    },
    "asset": {
      "id": "4d4ef1639c1046d49f51f5ab8cbb3fdf",
      "type": "image",
      "links": {
        "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/images/4d4ef1639c1046d49f51f5ab8cbb3fdf",
        "task": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf"
      }
    }
  }
}

task_asset_draft_removed

When a draft is removed from an asset of a task. Currently supported asset types: image, video and raw_file.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_asset_draft_removed.
dataobjectData of the event.
data[task]objectData of the task associated with the updated asset.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task.
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets of the task through Welcome Open API.
data[asset]objectData of the asset for which a new draft was added.
data[asset][id]stringUnique identifier of the asset.
data[asset][type]stringType of the asset. Value can be image, video or raw_file.
data[asset][links]objectLinks related to the asset
data[asset][links][self]stringURL to fetch the asset through Welcome Open API.
data[asset][links][task]stringURL to fetch the task of the asset through Welcome Open API.

Example

{
  "event_name": "task_asset_draft_removed",
  "data": {
    "task": {
      "id":"3e34f1639c1046d49f51f5ab8cbb3fdf",
      "links":{
        "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf",
        "assets": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/assets"
      }
    },
    "asset": {
      "id": "4d43f1639c1046d49f51f5ab8cbb3fdf",
      "type": "image",
      "links": {
        "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/images/4d43f1639c1046d49f51f5ab8cbb3fdf",
        "task": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf"
      }
    }
  }
}

task_custom_field_modified

When values are updated for custom fields of a task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is task_custom_field_modified.
dataobjectData of the event.
data[modified_custom_fields]arrayArray of custom fields which have been modified.
data[modified_custom_fields][\<index\>][id]stringUnique identifier of the custom field.
data[modified_custom_fields][\<index\>][links]stringLinks related to the custom field.
data[modified_custom_fields][\<index\>][links][self]stringURL to fetch the custom field through Welcome Open API.
data[task]objectData of the task associated with the custom fields.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task.
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets of the task through Welcome Open API.
data[task][links][custom_fields]stringURL to fetch the custom fields associated the task through Welcome Open API.

Example

{
  "event_name": "task_custom_field_modified",
  "data": {
    "modified_custom_fields": [
      {
        "id": "45aafc5f9eec1cde2028d3245435c2",
        "links": {
          "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/custom-fields/45aafc5f9eec1cde2028d3245435c2",
        }
      },
      {
        "id": "45aafc5f9eec1cde2028d3245435c3",
        "links": {
          "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/custom-fields/45aafc5f9eec1cde2028d3245435c3",
        }
      },
      {
        "id": "45aafc5f9eec1cde2028d3245435c4",
        "links": {
          "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/custom-fields/45aafc5f9eec1cde2028d3245435c4",
        }
      }
    ],
    "task": {
      "id": "3e34f1639c1046d49f51f5ab8cbb3fdf",
      "links": {
        "self": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf",
        "assets": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/assets",
        "custom_fields": "https://api.welcomesoftware.com/v3/tasks/3e34f1639c1046d49f51f5ab8cbb3fdf/custom-fields"
      }
    }
  }
}

Did this page help you?