Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI ReferenceUser Guide
Dev GuideAPI ReferenceChangelog
Dev GuideAPI ReferenceUser GuideLegal TermsDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
Legal TermsDev CommunityOptimizely AcademySubmit a ticket

Publish events

asset_published

An asset was published to a webhook type channel.

Payload

KeyTypeDescription
event_namestringName of the event. The value is asset_published.
dataobjectData of the event.
data[assets]objectData of the assets associated with the publishing event.
data[assets][articles]arrayArray of articles associated with the publishing event.
data[assets][articles][id]stringUnique identifier of the article.
data[assets][articles][title]stringTitle of the article.
data[assets][articles][created_at]stringDate of creation of the article.
data[assets][articles][modified_at]stringDate of latest modification of the article.
data[assets][articles][html_body]stringHTML body of the article.
data[assets][articles][images]arrayList of images associated with the article.
data[assets][articles][images][attribution_text]stringAttribution text of image.
data[assets][articles][images][caption]stringCaption of the image.
data[assets][articles][images][description]stringDescription of the image.
data[assets][articles][images][mime_type]stringMIME type of the image.
data[assets][articles][images][height]stringHeight of the image.
data[assets][articles][images][width]stringWidth of the image.
data[assets][articles][images][source]stringSource of the image.
data[assets][articles][images][source][name]stringname of the source of the image.
data[assets][articles][images][url]stringURL of the image.
data[assets][articles][images][thumbnail]stringThumbnail of the image.
data[assets][articles][labels]arrayList of labels associated with the article.
data[assets][articles][labels][group]objectLabel group associated with the article.
data[assets][articles][labels][group][id]stringUnique identifier of the label group.
data[assets][articles][labels][group][name]stringName of the Label group.
data[assets][articles][labels][values]objectSelected values for label group.
data[assets][articles][labels][values][id]stringUnique identifier of the label value.
data[assets][articles][labels][values][name]stringName of label value.
data[assets][articles][links]objectLinks related to the article.
data[assets][articles][links][self]stringURL to fetch article through the CMP Open API.
data[assets][images]arrayArray of images associated with the publishing event.
data[assets][images][id]stringUnique identifier of the image.
data[assets][images][title]stringTitle of the image.
data[assets][images][mime_type]stringMIME type of the image.
data[assets][images][created_at]stringDate of creation of the image.
data[assets][images][modified_at]stringDate of latest modification of the image.
data[assets][images][file_size]stringFile size of the image.
data[assets][images][image_resolution]objectResolution of the image.
data[assets][images][image_resolution][height]stringHeight of the image.
data[assets][images][image_resolution][width]stringWidth of the image.
data[assets][images][url]stringURL of the image.
data[assets][images][labels]arrayLabels associated with the image.
data[assets][images][labels][group]objectLabel group associated with the image.
data[assets][images][labels][group][id]stringUnique identifier of the label group.
data[assets][images][labels][group][name]stringName of the Label group.
data[assets][images][labels][values]objectSelected values for label group.
data[assets][images][labels][values][id]stringUnique identifier of the label value.
data[assets][images][labels][values][name]stringName of label value.
data[assets][images][links]objectLinks related to the image.
data[assets][images][links][self]stringURL to fetch image through the CMP Open API.
data[assets][videos]arrayArray of videos associated with the publishing event.
data[assets][videos][id]stringUnique identifier of the video.
data[assets][videos][title]stringTitle of the video.
data[assets][videos][mime_type]stringMIME type of the video.
data[assets][videos][created_at]stringDate of creation of the video.
data[assets][videos][modified_at]stringDate of latest modification of the video.
data[assets][videos][file_size]stringFile size of the video.
data[assets][videos][url]arrayURL of the video.
data[assets][videos][labels]arrayLabels associated with the video.
data[assets][videos][labels][group]objectLabel group associated with the video.
data[assets][videos][labels][group][id]stringUnique identifier of the label group.
data[assets][videos][labels][group][name]stringName of the Label group.
data[assets][videos][labels][values]objectSelected values for label group.
data[assets][videos][labels][values][id]stringUnique identifier of the label value.
data[assets][videos][labels][values][name]stringName of label value.
data[assets][videos][links]objectLinks related to the video.
data[assets][videos][links][self]stringURL to fetch video through the CMP Open API.
data[assets][raw_files]arrayArray of raw files associated with the publishing event.
data[assets][raw_files][id]stringUnique identifier of the raw file.
data[assets][raw_files][title]stringtitle of the raw file.
data[assets][raw_files][mime_type]stringMIME type of the raw file.
data[assets][raw_files][created_at]stringDate of creation of the raw file.
data[assets][raw_files][modified_at]stringDate of latest modification of the raw file.
data[assets][raw_files][file_size]stringFile size of the raw file.
data[assets][raw_files][url]arrayURL of the raw file.
data[assets][raw_files][labels]arrayLabels associated with the raw file.
data[assets][raw_files][labels][group]objectLabel group associated with the raw file.
data[assets][raw_files][labels][group][id]stringUnique identifier of the label group.
data[assets][raw_files][labels][group][name]stringName of the Label group.
data[assets][raw_files][labels][values]objectSelected values for label group.
data[assets][raw_files][labels][values][id]stringUnique identifier of the label value.
data[assets][raw_files][labels][values][name]stringName of label value.
data[assets][raw_files][links]objectLinks related to the raw file.
data[assets][raw_files][links][self]stringURL to fetch a raw file through the CMP Open API.
data[assets][structured_contents]array of StructuredContentModelArray of structured contents related to publishing event.
data[publishing_event]objectPublishing event related information.
data[publishing_event][id]stringUnique identifier of publishing event.
data[publishing_event][links]objectLinks related to publishing event.
data[publishing_event][links][self]stringURL to fetch publishing event through the CMP Open API.
data[publishing_event][links][publishing_metadata]stringURL to fetch publishing metadata through the CMP Open API.
data[organization]objectOrganization from which a publishing event occurred.
data[organization][id]stringUnique identifier of organization.
data[triggered_from]objectSource from where the event was generated.
data[triggered_from][id]stringUnique identifier of the source.
data[triggered_from][source_type]stringType of the source.
data[triggered_from][links]objectLinks related to the source.
data[triggered_from][links][self]stringURL to fetch the source data.

Example

{
  "event_name": "asset_published",
  "data": {
    "assets": {
      "articles": [
        {
          "id": "5d7f910551b00a722e0418830cee2212",
          "title": "Sample Article",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "html_body": "<p>hello world</p>",
          "images": [
            {
              "attribution_text": "",
              "caption": "Untitled",
              "description": "",
              "mime_type": "image/jpeg",
              "height": 480,
              "source": {
                "name": "Motley Fool DE"
              },
              "url": "http://images.cmp.optimizely.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==",
              "width": 720,
              "thumbnail": "http://images.cmp.optimizely.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==?width=75&height=75"
            }
          ],
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/articles/5d7f910551b00a722e0418830cee2212"
          }
        }
      ],
      "images": [
        {
          "id": "5d7f910551b00a722e0418830cee2213",
          "title": "Sample Image",
          "mime_type": "image/jpeg",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "file_size": 11244,
          "image_resolution": {
            "height": 800,
            "width": 700
          },
          "url": "https://images1.cmp.optimizely.com/Zz00NGIzZGNlZTM4MmYxMWVjYTQ3M2NhZjc5Y2RkMTFiNA==",
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/images/5d7f910551b00a722e0418830cee2213"
          }
        }
      ],
      "videos": [
        {
          "id": "5d7f910551b00a722e0418830cee2214",
          "title": "Sample Video",
          "mime_type": "video/mp4",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "file_size": 112448,
          "url": "https://ohclbk.files.cmp.optimizely.com/download/03d8584cff6a11eb99ad11d217c3001b",
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/videos/5d7f910551b00a722e0418830cee2214"
          }
        }
      ],
      "raw_files": [
        {
          "id": "5d7f910551b00a722e0418830cee2215",
          "title": "Sample Raw File",
          "mime_type": "application/pdf",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "file_size": 81244,
          "url": "https://ohclbk.files.cmp.optimizely.com/download/b4d6821e26e911ecbf8a8140198b1683",
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/raw-files/5d7f910551b00a722e0418830cee2215"
          }
        }
      ],
      "structured_contents": [<structured_contents>]
    },
    "publishing_event": {
      "id": "5d7f910551b00a722e0418830cee5534",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534",
        "publishing_metadata": "https://api.cmp.optimizely.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534/publishing-metadata"
      }
    },
    "triggered_from": {
      "id": "62a80bcb3b162c1c47a72fcb",
      "source_type": "task",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/62a80bcb3b162c1c47a72fcb"
      }
    },
    "organization": {
      "id": "5d75447b7f1c1c000957d362"
    }
  }
}

asset_synced

A version was added to an asset that was published to a webhook type channel

Payload

KeyTypeDescription
event_namestringName of the event. The value is asset_synced.
dataobjectData of the event.
data[assets]objectData of the assets associated with the publishing event.
data[assets][articles]arrayArray of articles associated with the publishing event
data[assets][articles][id]stringUnique identifier of the article.
data[assets][articles][title]stringTitle of the article.
data[assets][articles][created_at]stringDate of creation of the article.
data[assets][articles][modified_at]stringDate of latest modification of the article.
data[assets][articles][html_body]stringHTML body of the article.
data[assets][articles][images]arrayList of images associated with the article.
data[assets][articles][images][attribution_text]stringAttribution text of image.
data[assets][articles][images][caption]stringCaption of the image.
data[assets][articles][images][description]stringDescription of the image.
data[assets][articles][images][mime_type]stringMIME type of the image.
data[assets][articles][images][height]stringHeight of the image.
data[assets][articles][images][width]stringWidth of the image.
data[assets][articles][images][source]stringSource of the image.
data[assets][articles][images][source][name]stringName of the source of the image.
data[assets][articles][images][url]stringURL of the image.
data[assets][articles][images][thumbnail]stringThumbnail of the image.
data[assets][articles][labels]arrayList of labels associated with the article.
data[assets][articles][labels][group]objectLabel group associated with the article.
data[assets][articles][labels][group][id]stringUnique identifier of the label group.
data[assets][articles][labels][group][name]stringName of the Label group.
data[assets][articles][labels][values]objectSelected values for label group.
data[assets][articles][labels][values][id]stringUnique identifier of the label value.
data[assets][articles][labels][values][name]stringName of label value.
data[assets][articles][links]objectLinks related to the article.
data[assets][articles][links][self]stringURL to fetch article through the CMP Open API.
data[assets][images]arrayArray of images associated with the publishing event.
data[assets][images][id]stringUnique identifier of the image.
data[assets][images][title]stringTitle of the image.
data[assets][images][mime_type]stringMIME type of the image.
data[assets][images][created_at]stringDate of creation of the image.
data[assets][images][modified_at]stringDate of latest modification of the image.
data[assets][images][file_size]stringFile size of the image.
data[assets][images][image_resolution]objectResolution of the image.
data[assets][images][image_resolution][height]stringHeight of the image.
data[assets][images][image_resolution][width]stringWidth of the image.
data[assets][images][url]stringURL of the image.
data[assets][images][labels]arrayLabels associated with the image.
data[assets][images][labels][group]objectLabel group associated with the image.
data[assets][images][labels][group][id]stringUnique identifier of the label group.
data[assets][images][labels][group][name]stringName of the Label group.
data[assets][images][labels][values]objectSelected values for label group.
data[assets][images][labels][values][id]stringUnique identifier of the label value.
data[assets][images][labels][values][name]stringName of label value.
data[assets][images][links]objectLinks related to the image.
data[assets][images][links][self]stringURL to fetch image through the CMP Open API.
data[assets][videos]arrayArray of videos associated with the publishing event.
data[assets][videos][id]stringUnique identifier of the video.
data[assets][videos][title]stringTitle of the video.
data[assets][videos][mime_type]stringMIME type of the video.
data[assets][videos][created_at]stringDate of creation of the video.
data[assets][videos][modified_at]stringDate of latest modification of the video.
data[assets][videos][file_size]stringFile size of the video.
data[assets][videos][url]arrayURL of the video.
data[assets][videos][labels]arrayLabels associated with the video.
data[assets][videos][labels][group]objectLabel group associated with the video.
data[assets][videos][labels][group][id]stringUnique identifier of the label group.
data[assets][videos][labels][group][name]stringName of the Label group.
data[assets][videos][labels][values]objectSelected values for label group.
data[assets][videos][labels][values][id]stringUnique identifier of the label value.
data[assets][videos][labels][values][name]stringName of label value.
data[assets][videos][links]objectLinks related to the video.
data[assets][videos][links][self]stringURL to fetch video through the CMP Open API.
data[assets][raw_files]arrayArray of raw files associated with the publishing event.
data[assets][raw_files][id]stringUnique identifier of the raw file.
data[assets][raw_files][title]stringtitle of the raw file.
data[assets][raw_files][mime_type]stringMIME type of the raw file.
data[assets][raw_files][created_at]stringDate of creation of the raw file.
data[assets][raw_files][modified_at]stringDate of latest modification of the raw file.
data[assets][raw_files][file_size]stringFile size of the raw file.
data[assets][raw_files][url]arrayURL of the raw file.
data[assets][raw_files][labels]arrayLabels associated with the raw file.
data[assets][raw_files][labels][group]objectLabel group associated with the raw file.
data[assets][raw_files][labels][group][id]stringUnique identifier of the label group.
data[assets][raw_files][labels][group][name]stringName of the Label group.
data[assets][raw_files][labels][values]objectSelected values for label group.
data[assets][raw_files][labels][values][id]stringUnique identifier of the label value.
data[assets][raw_files][labels][values][name]stringName of label value.
data[assets][raw_files][links]objectLinks related to the raw file.
data[assets][raw_files][links][self]stringURL to fetch a raw file through the CMP Open API.
data[assets][structured_contents]array of StructuredContentModelArray of structured contents related to publishing event.
data[publishing_event]objectPublishing event related information.
data[publishing_event][id]stringUnique identifier of publishing event.
data[publishing_event][links]objectLinks related to publishing event.
data[publishing_event][links][self]stringURL to fetch publishing event through the CMP Open API.
data[publishing_event][links][publishing_metadata]stringURL to fetch publishing metadata through the CMP Open API.
data[organization]objectOrganization from which a publishing event occurred.
data[organization][id]stringUnique identifier of organization.

Example

{
  "event_name": "asset_synced",
  "data": {
    "assets": {
      "articles": [
        {
          "id": "5d7f910551b00a722e0418830cee2212",
          "title": "Sample Article",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "html_body": "<p>hello world</p>",
          "images": [
            {
              "attribution_text": "",
              "caption": "Untitled",
              "description": "",
              "mime_type": "image/jpeg",
              "height": 480,
              "source": {
                "name": "Motley Fool DE"
              },
              "url": "http://images.cmp.optimizely.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==",
              "width": 720,
              "thumbnail": "http://images.cmp.optimizely.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==?width=75&height=75"
            }
          ],
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/articles/5d7f910551b00a722e0418830cee2212"
          }
        }
      ],
      "images": [
        {
          "id": "5d7f910551b00a722e0418830cee2213",
          "title": "Sample Image",
          "mime_type": "image/jpeg",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "file_size": 11244,
          "image_resolution": {
            "height": 800,
            "width": 700
          },
          "url": "https://images1.cmp.optimizely.com/Zz00NGIzZGNlZTM4MmYxMWVjYTQ3M2NhZjc5Y2RkMTFiNA==",
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/images/5d7f910551b00a722e0418830cee2213"
          }
        }
      ],
      "videos": [
        {
          "id": "5d7f910551b00a722e0418830cee2214",
          "title": "Sample Video",
          "mime_type": "video/mp4",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "file_size": 112448,
          "url": "https://ohclbk.files.cmp.optimizely.com/download/03d8584cff6a11eb99ad11d217c3001b",
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/videos/5d7f910551b00a722e0418830cee2214"
          }
        }
      ],
      "raw_files": [
        {
          "id": "5d7f910551b00a722e0418830cee2215",
          "title": "Sample Raw File",
          "mime_type": "application/pdf",
          "created_at": "2019-10-06T13:15:30Z",
          "modified_at": "2019-10-07T13:15:30Z",
          "file_size": 81244,
          "url": "https://ohclbk.files.cmp.optimizely.com/download/b4d6821e26e911ecbf8a8140198b1683",
          "labels": [
            {
              "group": {
                "id": "123123",
                "name": "Content Format"
              },
              "values": [
                {
                  "id": "234234",
                  "name": "content format 1"
                }
              ]
            }
          ],
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/raw-files/5d7f910551b00a722e0418830cee2215"
          }
        }
      ],
      "structured_contents": [<structured_contents>]
    },
    "publishing_event": {
      "id": "5d7f910551b00a722e0418830cee5534",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534",
        "publishing_metadata": "https://api.cmp.optimizely.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534/publishing-metadata"
      }
    },
    "organization": {
      "id": "5d75447b7f1c1c000957d362"
    }
  }
}

asset_unpublished

An asset, that was published through a publishing webhook type channel, was unpublished.

Payload

KeyTypeDescription
event_namestringName of the event. The value is asset_unpublished.
dataobjectData of the event.
data[assets]objectData of the assets associated with the publishing event.
data[assets][articles]arrayArray of articles associated with the publishing event.
data[assets][articles][id]stringUnique identifier of the article.
data[assets][articles][links]objectLinks related to the article.
data[assets][articles][links][self]stringURL to fetch article through the CMP Open API.
data[assets][images]arrayArray of images associated with the publishing event.
data[assets][images][id]stringUnique identifier of the image.
data[assets][images][links]objectLinks related to the image.
data[assets][images][links][self]stringURL to fetch image through the CMP Open API.
data[assets][videos]arrayArray of videos associated with the publishing event.
data[assets][videos][id]stringUnique identifier of the video.
data[assets][videos][links]objectLinks related to the video.
data[assets][videos][links][self]stringURL to fetch video through the CMP Open API.
data[assets][raw_files]arrayArray of raw files associated with the publishing event.
data[assets][raw_files][id]stringUnique identifier of the raw file.
data[assets][raw_files][links]objectLinks related to the raw file.
data[assets][raw_files][links][self]stringURL to fetch a raw file through the CMP Open API.
data[assets][structured_contents]array of StructuredContentModelArray of structured contents related to publishing event.
data[publishing_event]objectPublishing event related information.
data[publishing_event][id]stringUnique identifier of publishing event.
data[publishing_event][links]objectLinks related to publishing event.
data[publishing_event][links][self]stringURL to fetch publishing event through the CMP Open API.
data[publishing_event][links][publishing_metadata]stringURL to fetch publishing metadata through the CMP Open API.
data[organization]objectOrganization from which a publishing event occurred.
data[organization][id]stringUnique identifier of organization.

Example

{
  "event_name": "asset_unpublished",
  "data": {
    "assets": {
      "articles": [
        {
          "id": "5d7f910551b00a722e0418830cee2212",
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/articles/5d7f910551b00a722e0418830cee2212"
          }
        }
      ],
      "images": [
        {
          "id": "5d7f910551b00a722e0418830cee2213",
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/images/5d7f910551b00a722e0418830cee2213"
          }
        }
      ],
      "videos": [
        {
          "id": "5d7f910551b00a722e0418830cee2214",
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/videos/5d7f910551b00a722e0418830cee2214"
          }
        }
      ],
      "raw_files": [
        {
          "id": "5d7f910551b00a722e0418830cee2215",
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/raw-files/5d7f910551b00a722e0418830cee2215"
          }
        }
      ],
      "structured_contents": [<structured_contents>]
    },
    "publishing_event": {
      "id": "5d7f910551b00a722e0418830cee5534",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534",
        "publishing_metadata": "https://api.cmp.optimizely.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534/publishing-metadata"
      }
    },
    "organization": {
      "id": "5d75447b7f1c1c000957d362"
    }
  }
}