Task events

content_preview_requested (experimental)

When structured content preview is requested.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is content_preview_requested.
---	---	---
data	object	Data of the event.
data[assets]	object	Data of the assets associated with the event.
data[assets][structured\_contents]	array of ContentPreviewStructuredContentModel	Array of structured contents
data[organization]	object	Organization from which the preview request was fired
data[organization][id]	string	Unique identifier of organization
links	object	Links related to the event
links[acknowledge]	string	URL to acknowledge the preview through Welcome Open API
links[complete]	string	URL to complete the preview through Welcome Open API

Example

{
  "event_name": "content_preview_requested",
  "data": {
    "assets": {
      "structured_contents": [<structured_contents>]
    },
    "organization": {
      "id": "5d75447b7f1c1c000957d362"
    },
    "links": {
      "acknowledge": "https://api.welcomesoftware.com/v3/structured-content/contents/1e7d1ebe28fd4378a0aa4cc300bc039e/versions/e790f3ec824544ea99d01c6f54c1d3c1/previews/b07bfc4c3d694e3d89982c9fc1698777/acknowledge",
      "complete": "https://api.welcomesoftware.com/v3/structured-content/contents/1e7d1ebe28fd4378a0aa4cc300bc039e/versions/e790f3ec824544ea99d01c6f54c1d3c1/previews/b07bfc4c3d694e3d89982c9fc1698777/complete"
    }
  }
}

task_asset_added

Add an asset (article, image, video or raw file) to a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_asset_added`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the deleted asset.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][assets]	string	URL to fetch the assets of the task through Optimizely Content Marketing Platform Open API.
data[asset]	object	Data of the asset associated with the event.
data[asset][id]	string	Unique identifier of the asset.
data[asset][type]	string	Type of the asset. Value can be `article`, `image`, `video` or `raw_file`.
data[asset][links]	object	Links related to the asset
data[asset][links][self]	string	URL to fetch the asset through Optimizely Content Marketing Platform Open API.
data[asset][links][task]	string	URL to fetch the task of the asset through Optimizely Content Marketing Platform 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_draft_added

Add a draft to an asset of a task. Currently supported asset types: image, video and raw_file.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_asset_draft_added`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the updated asset.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task.
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][assets]	string	URL to fetch the assets of the task through Optimizely Content Marketing Platform Open API.
data[asset]	object	Data of the asset for which a new draft was added.
data[asset][id]	string	Unique identifier of the asset.
data[asset][type]	string	Type of the asset. Value can be `image`, `video` or `raw_file`.
data[asset][links]	object	Links related to the asset
data[asset][links][self]	string	URL to fetch the asset through Optimizely Content Marketing Platform Open API.
data[asset][links][task]	string	URL to fetch the task of the asset through Optimizely Content Marketing Platform 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

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

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_asset_draft_removed`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the updated asset.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task.
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][assets]	string	URL to fetch the assets of the task through Optimizely Content Marketing Platform Open API.
data[asset]	object	Data of the asset for which a new draft was added.
data[asset][id]	string	Unique identifier of the asset.
data[asset][type]	string	Type of the asset. Value can be `image`, `video` or `raw_file`.
data[asset][links]	object	Links related to the asset
data[asset][links][self]	string	URL to fetch the asset through Optimizely Content Marketing Platform Open API.
data[asset][links][task]	string	URL to fetch the task of the asset through Optimizely Content Marketing Platform 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_asset_modified

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

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_asset_modified`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the modified asset.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][assets]	string	URL to fetch the assets of the task through Optimizely Content Marketing Platform Open API.
data[asset]	object	Data of the asset associated with the event.
data[asset][id]	string	Unique identifier of the asset.
data[asset][type]	string	Type of the asset. Value can be `article`, `image`, `video` or `raw_file`.
data[asset][links]	object	Links related to the asset
data[asset][links][self]	string	URL to fetch the asset through Optimizely Content Marketing Platform Open API.
data[asset][links][task]	string	URL to fetch the task of the asset through Optimizely Content Marketing Platform 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_removed

Remove an asset (article, image, video or raw file) from a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_asset_removed`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the deleted asset.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][assets]	string	URL to fetch the assets of the task through Optimizely Content Marketing Platform Open API.
data[asset]	object	Data of the asset associated with the event.
data[asset][id]	string	Unique identifier of the asset.
data[asset][type]	string	Type 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_brief_added

Add a brief to a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_brief_added`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the brief.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task.
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][brief]	string	URL to fetch the task brief through Optimizely Content Marketing Platform 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_modified

Modify a brief of a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_brief_modified`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the brief.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task.
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][brief]	string	URL to fetch the task brief through Optimizely Content Marketing Platform 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_brief_removed

Remove a brief from a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_brief_removed`.
data	object	Data of the event.
data[task]	object	Data of the task associated with the brief.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task.
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.

Example

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

task_custom_field_modified

Update values for custom fields of a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_custom_field_modified`.
data	object	Data of the event.
data[modified_custom_fields]	array	Array of custom fields which have been modified.
data[modified_custom_fields][\<index\>][id]	string	Unique identifier of the custom field.
data[modified_custom_fields][\<index\>][links]	string	Links related to the custom field.
data[modified_custom_fields][\<index\>][links][self]	string	URL to fetch the custom field through Optimizely Content Marketing Platform Open API.
data[task]	object	Data of the task associated with the custom fields.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task.
data[task][links][self]	string	URL to fetch the task through Optimizely Content Marketing Platform Open API.
data[task][links][assets]	string	URL to fetch the assets of the task through Optimizely Content Marketing Platform Open API.
data[task][links][custom_fields]	string	URL to fetch the custom fields associated the task through Optimizely Content Marketing Platform 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"
      }
    }
  }
}

task_metadata_modified

Modify the following properties of a task.

Title
Campaign
Start at
Due at
Is completed
Is archived
Labels

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_metadata_modifed`.
data	object	Data of the event.
data[task]	object	Data of the task which has been removed.
data[task][id]	string	Unique identifier of the task.
data[task][links]	object	Links related to the task
data[task][links][self]	string	URL to fetch task through Optimizely Content Marketing Platform Open API.

Example

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

task_removed

Remove a task.

Payload

Key	Type	Description
event_name	string	Name of the event. For this event, the value is `task_removed`.
data	object	Data of the event.
data[task]	object	Data of the task which has been removed.
data[task][id]	string	Unique identifier of the task.

Example

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