Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In

Library events

asset_added

Add an asset (article, image, video or raw file) to the Library for several reasons including, but not limited to, uploading assets, completing a task, and so on.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is asset_added.
dataobjectData of the event.
data[asset]objectData of the asset associated with the event.
data[asset][id]stringUnique identifier of the asset.
data[asset][owner_organization_id]stringOwner organization ID 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's details through Optimizely Content Marketing Platform Open API.

Example

{
  "event_name": "asset_added",
  "data": {
    "asset": {
      "id": "019a86405de737b4ec3e616a4aeff981",
      "owner_organization_id": "5108c3a9becac35915111191",
      "type": "image",
      "links": {
        "self": "https://api.welcomesoftware.com/v3/images/019a86405de737b4ec3e616a4aeff981"
      }
    }
  }
}

asset_removed

Remove an asset (article, image, video or raw file) from the Library for several reasons including, but not limited to, deleting assets.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is asset_removed.
dataobjectData of the event.
data[asset]objectData of the asset associated with the event.
data[asset][id]stringUnique identifier of the asset.
data[asset][owner_organization_id]stringOwner organization ID of the asset
data[asset][type]stringType of the asset. Value can be article, image, video or raw_file.

Example

{
  "event_name": "asset_removed",
  "data": {
    "asset": {
      "id": "870825113a12950a7eeeb64a64236d49",
      "owner_organization_id": "5108c3a9becac35915111191",
      "type": "article"
    }
  }
}

asset_modified

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

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is asset_modified.
dataobjectData of the event.
data[asset]objectData of the asset associated with the event.
data[asset][id]stringUnique identifier of the asset.
data[asset][owner_organization_id]stringOwner organization ID 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's details through Optimizely Content Marketing Platform Open API.

Example

{
  "event_name": "asset_modified",
  "data": {
    "asset": {
      "id": "019a86405de737b4ec3e616a4aeff951",
      "owner_organization_id": "5108c3a9becac35915111191",
      "type": "image",
      "links": {
        "self": "https://api.welcomesoftware.com/v3/images/019a86405de737b4ec3e616a4aeff951"
      }
    }
  }
}