Publishing events
asset_published (experimental)
Publish an asset via a publishing webhook type channel.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is asset_published . |
data | object | Data of the event. |
data[assets] | object | Data of the assets associated with the publishing event. |
data[assets][articles] | array | Array of articles associated with the publishing event |
data[assets][articles][id] | string | Unique identifier of the article |
data[assets][articles][title] | string | Title of the article |
data[assets][articles][created_at] | string | Date of creation of the article |
data[assets][articles][modified_at] | string | Date of latest modification of the article |
data[assets][articles][html_body] | string | HTML body of the artile |
data[assets][articles][images] | array | List of images associated with the article |
data[assets][articles][images][attribution_text] | string | Attribution text of image |
data[assets][articles][images][caption] | string | Caption of the image |
data[assets][articles][images][description] | string | Description of the image |
data[assets][articles][images][mime_type] | string | MIME type of the image |
data[assets][articles][images][height] | string | Height of the image |
data[assets][articles][images][width] | string | Width of th image |
data[assets][articles][images][source] | string | Source of the image |
data[assets][articles][images][source][name] | string | name of the source of the image |
data[assets][articles][images][url] | string | URL of the image |
data[assets][articles][images][thumbnail] | string | Thumbnail of the image |
data[assets][articles][labels] | array | List of labels associated with the article |
data[assets][articles][labels][group] | object | Label group associated with the article |
data[assets][articles][labels][group][id] | string | Unique identifier of the label group |
data[assets][articles][labels][group][name] | string | Name of the Label group |
data[assets][articles][labels][values] | object | Selected values for label group |
data[assets][articles][labels][values][id] | string | Unique identifier of the label value |
data[assets][articles][labels][values][name] | string | Name of label value |
data[assets][articles][links] | object | Links related to the article |
data[assets][articles][links][self] | string | URL to fetch article through Optimizely Content Marketing Platform Open API. |
data[assets][images] | array | Array of images associated with the publishing event |
data[assets][images][id] | string | Unique identifier of the image |
data[assets][images][title] | string | Title of the image |
data[assets][images][mime_type] | string | MIME type of the image |
data[assets][images][created_at] | string | Date of creation of the image |
data[assets][images][modified_at] | string | Date of latest modification of the image |
data[assets][images][file_size] | string | File size of the image |
data[assets][images][image_resolution] | object | Resolution of the image |
data[assets][images][image_resolution][height] | string | Height of the image |
data[assets][images][image_resolution][width] | string | Width of the image |
data[assets][images][url] | string | URL of the image |
data[assets][images][labels] | array | Labels associated with the image |
data[assets][images][labels][group] | object | Label group associated with the image |
data[assets][images][labels][group][id] | string | Unique identifier of the label group |
data[assets][images][labels][group][name] | string | Name of the Label group |
data[assets][images][labels][values] | object | Selected values for label group |
data[assets][images][labels][values][id] | string | Unique identifier of the label value |
data[assets][images][labels][values][name] | string | Name of label value |
data[assets][images][links] | object | Links related to the image |
data[assets][images][links][self] | string | URL to fetch image through Optimizely Content Marketing Platform Open API. |
data[assets][videos] | array | Array of videos associated with the publishing event |
data[assets][videos][id] | string | Unique identifier of the video |
data[assets][videos][title] | string | title of the video |
data[assets][videos][mime_type] | string | MIME type of the video |
data[assets][videos][created_at] | string | Date of creation of the video |
data[assets][videos][modified_at] | string | Date of latest modification of the video |
data[assets][videos][file_size] | string | file size of the video |
data[assets][videos][url] | array | URL of the video |
data[assets][videos][labels] | array | Labels associated with the video |
data[assets][videos][labels][group] | object | Label group associated with the video |
data[assets][videos][labels][group][id] | string | Unique identifier of the label group |
data[assets][videos][labels][group][name] | string | Name of the Label group |
data[assets][videos][labels][values] | object | Selected values for label group |
data[assets][videos][labels][values][id] | string | Unique identifier of the label value |
data[assets][videos][labels][values][name] | string | Name of label value |
data[assets][videos][links] | object | Links related to the video |
data[assets][videos][links][self] | string | URL to fetch video through Optimizely Content Marketing Platform Open API. |
data[assets][raw_files] | array | Array of raw files associated with the publishing event |
data[assets][raw_files][id] | string | Unique identifier of the raw file |
data[assets][raw_files][title] | string | title of the raw file |
data[assets][raw_files][mime_type] | string | MIME type of the raw file |
data[assets][raw_files][created_at] | string | Date of creation of the raw file |
data[assets][raw_files][modified_at] | string | Date of latest modification of the raw file |
data[assets][raw_files][file_size] | string | File size of the raw file |
data[assets][raw_files][url] | array | URL of the raw file |
data[assets][raw_files][labels] | array | Labels associated with the raw file |
data[assets][raw_files][labels][group] | object | Label group associated with the raw file |
data[assets][raw_files][labels][group][id] | string | Unique identifier of the label group |
data[assets][raw_files][labels][group][name] | string | Name of the Label group |
data[assets][raw_files][labels][values] | object | Selected values for label group |
data[assets][raw_files][labels][values][id] | string | Unique identifier of the label value |
data[assets][raw_files][labels][values][name] | string | Name of label value |
data[assets][raw_files][links] | object | Links related to the raw file |
data[assets][raw_files][links][self] | string | URL to fetch raw file through Optimizely Content Marketing Platform Open API. |
data[publishing_event] | object | Publishing event related information |
data[publishing_event][id] | string | Unique identifier of publishing event |
data[publishing_event][links] | object | Links related to publishing event |
data[publishing_event][links][self] | string | URL to fetch publishing event through Optimizely Content Marketing Platform Open API. |
data[publishing_event][links][publishing_metadata] | string | URL to fetch publishing metadata through Optimizely Content Marketing Platform Open API. |
data[organization] | object | Organization from which publishing event was fired |
data[organization][id] | string | Unique identifier of organization |
data[triggered_from] | object | Source from where the event was generated |
data[triggered_from][id] | string | Unique identifier of the source |
data[triggered_from][source_type] | string | Type of the source |
data[triggered_from][links] | object | Links related to the source |
data[triggered_from][links][self] | string | URL 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.newscred.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==",
"width": 720,
"thumbnail": "http://images.newscred.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==?width=75&height=75"
}
],
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.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.welcomesoftware.com/Zz00NGIzZGNlZTM4MmYxMWVjYTQ3M2NhZjc5Y2RkMTFiNA==",
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.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.welcomesoftware.com/download/03d8584cff6a11eb99ad11d217c3001b",
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.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.welcomesoftware.com/download/b4d6821e26e911ecbf8a8140198b1683",
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.com/v3/raw-files/5d7f910551b00a722e0418830cee2215"
}
}]
},
"publishing_event": {
"id": "5d7f910551b00a722e0418830cee5534",
"links": {
"self": "https://api.welcomesoftware.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534",
"publishing_metadata": "https://api.welcomesoftware.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534/publishing-metadata"
}
},
"triggered_from": {
"id": "62a80bcb3b162c1c47a72fcb",
"source_type": "task",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/62a80bcb3b162c1c47a72fcb"
}
},
"organization": {
"id": "5d75447b7f1c1c000957d362"
}
}
}
asset_synced (experimental)
Synchronize an asset published via a publishing webhook type channel.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is asset_syned . |
data | object | Data of the event. |
data[assets] | object | Data of the assets associated with the publishing event. |
data[assets][articles] | array | Array of articles associated with the publishing event |
data[assets][articles][id] | string | Unique identifier of the article |
data[assets][articles][title] | string | Title of the article |
data[assets][articles][created_at] | string | Date of creation of the article |
data[assets][articles][modified_at] | string | Date of latest modification of the article |
data[assets][articles][html_body] | string | HTML body of the artile |
data[assets][articles][images] | array | List of images associated with the article |
data[assets][articles][images][attribution_text] | string | Attribution text of image |
data[assets][articles][images][caption] | string | Caption of the image |
data[assets][articles][images][description] | string | Description of the image |
data[assets][articles][images][mime_type] | string | MIME type of the image |
data[assets][articles][images][height] | string | Height of the image |
data[assets][articles][images][width] | string | Width of th image |
data[assets][articles][images][source] | string | Source of the image |
data[assets][articles][images][source][name] | string | name of the source of the image |
data[assets][articles][images][url] | string | URL of the image |
data[assets][articles][images][thumbnail] | string | Thumbnail of the image |
data[assets][articles][labels] | array | List of labels associated with the article |
data[assets][articles][labels][group] | object | Label group associated with the article |
data[assets][articles][labels][group][id] | string | Unique identifier of the label group |
data[assets][articles][labels][group][name] | string | Name of the Label group |
data[assets][articles][labels][values] | object | Selected values for label group |
data[assets][articles][labels][values][id] | string | Unique identifier of the label value |
data[assets][articles][labels][values][name] | string | Name of label value |
data[assets][articles][links] | object | Links related to the article |
data[assets][articles][links][self] | string | URL to fetch article through Optimizely Content Marketing Platform Open API. |
data[assets][images] | array | Array of images associated with the publishing event |
data[assets][images][id] | string | Unique identifier of the image |
data[assets][images][title] | string | Title of the image |
data[assets][images][mime_type] | string | MIME type of the image |
data[assets][images][created_at] | string | Date of creation of the image |
data[assets][images][modified_at] | string | Date of latest modification of the image |
data[assets][images][file_size] | string | File size of the image |
data[assets][images][image_resolution] | object | Resolution of the image |
data[assets][images][image_resolution][height] | string | Height of the image |
data[assets][images][image_resolution][width] | string | Width of the image |
data[assets][images][url] | string | URL of the image |
data[assets][images][labels] | array | Labels associated with the image |
data[assets][images][labels][group] | object | Label group associated with the image |
data[assets][images][labels][group][id] | string | Unique identifier of the label group |
data[assets][images][labels][group][name] | string | Name of the Label group |
data[assets][images][labels][values] | object | Selected values for label group |
data[assets][images][labels][values][id] | string | Unique identifier of the label value |
data[assets][images][labels][values][name] | string | Name of label value |
data[assets][images][links] | object | Links related to the image |
data[assets][images][links][self] | string | URL to fetch image through Optimizely Content Marketing Platform Open API. |
data[assets][videos] | array | Array of videos associated with the publishing event |
data[assets][videos][id] | string | Unique identifier of the video |
data[assets][videos][title] | string | title of the video |
data[assets][videos][mime_type] | string | MIME type of the video |
data[assets][videos][created_at] | string | Date of creation of the video |
data[assets][videos][modified_at] | string | Date of latest modification of the video |
data[assets][videos][file_size] | string | file size of the video |
data[assets][videos][url] | array | URL of the video |
data[assets][videos][labels] | array | Labels associated with the video |
data[assets][videos][labels][group] | object | Label group associated with the video |
data[assets][videos][labels][group][id] | string | Unique identifier of the label group |
data[assets][videos][labels][group][name] | string | Name of the Label group |
data[assets][videos][labels][values] | object | Selected values for label group |
data[assets][videos][labels][values][id] | string | Unique identifier of the label value |
data[assets][videos][labels][values][name] | string | Name of label value |
data[assets][videos][links] | object | Links related to the video |
data[assets][videos][links][self] | string | URL to fetch video through Optimizely Content Marketing Platform Open API. |
data[assets][raw_files] | array | Array of raw files associated with the publishing event |
data[assets][raw_files][id] | string | Unique identifier of the raw file |
data[assets][raw_files][title] | string | title of the raw file |
data[assets][raw_files][mime_type] | string | MIME type of the raw file |
data[assets][raw_files][created_at] | string | Date of creation of the raw file |
data[assets][raw_files][modified_at] | string | Date of latest modification of the raw file |
data[assets][raw_files][file_size] | string | File size of the raw file |
data[assets][raw_files][url] | array | URL of the raw file |
data[assets][raw_files][labels] | array | Labels associated with the raw file |
data[assets][raw_files][labels][group] | object | Label group associated with the raw file |
data[assets][raw_files][labels][group][id] | string | Unique identifier of the label group |
data[assets][raw_files][labels][group][name] | string | Name of the Label group |
data[assets][raw_files][labels][values] | object | Selected values for label group |
data[assets][raw_files][labels][values][id] | string | Unique identifier of the label value |
data[assets][raw_files][labels][values][name] | string | Name of label value |
data[assets][raw_files][links] | object | Links related to the raw file |
data[assets][raw_files][links][self] | string | URL to fetch raw file through Optimizely Content Marketing Platform Open API. |
data[publishing_event] | object | Publishing event related information |
data[publishing_event][id] | string | Unique identifier of publishing event |
data[publishing_event][links] | object | Links related to publishing event |
data[publishing_event][links][self] | string | URL to fetch publishing event through Optimizely Content Marketing Platform Open API. |
data[publishing_event][links][publishing_metadata] | string | URL to fetch publishing metadata through Optimizely Content Marketing Platform Open API. |
data[organization] | object | Organization from which publishing event was fired |
data[organization][id] | string | Unique 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.newscred.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==",
"width": 720,
"thumbnail": "http://images.newscred.com/Zz02NWYzZDdkNDViMjQxMWVjYjAxZjAyNDJhYzEyMDAxYQ==?width=75&height=75"
}
],
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.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.welcomesoftware.com/Zz00NGIzZGNlZTM4MmYxMWVjYTQ3M2NhZjc5Y2RkMTFiNA==",
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.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.welcomesoftware.com/download/03d8584cff6a11eb99ad11d217c3001b",
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.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.welcomesoftware.com/download/b4d6821e26e911ecbf8a8140198b1683",
"labels": [{
"group": {
"id": "123123",
"name": "Content Format"
},
"values": [{
"id": "234234",
"name": "content format 1"
}]
}],
"links": {
"self": "https://api.welcomesoftware.com/v3/raw-files/5d7f910551b00a722e0418830cee2215"
}
}]
},
"publishing_event": {
"id": "5d7f910551b00a722e0418830cee5534", // publishing service distribution id / publishing job id
"links": {
"self": "https://api.welcomesoftware.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534",
"publishing_metadata": "https://api.welcomesoftware.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534/publishing-metadata"
}
},
"organization": {
"id": "5d75447b7f1c1c000957d362"
}
}
}
asset_unpublished (experimental)
Unpublish an asset published via a publishing webhook type channel.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is asset_unpublished . |
data | object | Data of the event. |
data[assets] | object | Data of the assets associated with the publishing event. |
data[assets][articles] | array | Array of articles associated with the publishing event |
data[assets][articles][id] | string | Unique identifier of the article |
data[assets][articles][links] | object | Links related to the article |
data[assets][articles][links][self] | string | URL to fetch article through Optimizely Content Marketing Platform Open API. |
data[assets][images] | array | Array of images associated with the publishing event |
data[assets][images][id] | string | Unique identifier of the image |
data[assets][images][links] | object | Links related to the image |
data[assets][images][links][self] | string | URL to fetch image through Optimizely Content Marketing Platform Open API. |
data[assets][videos] | array | Array of videos associated with the publishing event |
data[assets][videos][id] | string | Unique identifier of the video |
data[assets][videos][links] | object | Links related to the video |
data[assets][videos][links][self] | string | URL to fetch video through Optimizely Content Marketing Platform Open API. |
data[assets][raw_files] | array | Array of raw files associated with the publishing event |
data[assets][raw_files][id] | string | Unique identifier of the raw file |
data[assets][raw_files][links] | object | Links related to the raw file |
data[assets][raw_files][links][self] | string | URL to fetch raw file through Optimizely Content Marketing Platform Open API. |
data[publishing_event] | object | Publishing event related information |
data[publishing_event][id] | string | Unique identifier of publishing event |
data[publishing_event][links] | object | Links related to publishing event |
data[publishing_event][links][self] | string | URL to fetch publishing event through Optimizely Content Marketing Platform Open API. |
data[publishing_event][links][publishing_metadata] | string | URL to fetch publishing metadata through Optimizely Content Marketing Platform Open API. |
data[organization] | object | Organization from which publishing event was fired |
data[organization][id] | string | Unique identifier of organization |
Example
{
"event_name": "asset_unpublished",
"data": {
"assets": {
"articles": [{
"id": "5d7f910551b00a722e0418830cee2212",
"links": {
"self": "https://api.welcomesoftware.com/v3/articles/5d7f910551b00a722e0418830cee2212"
}
}],
"images": [{
"id": "5d7f910551b00a722e0418830cee2213",
"links": {
"self": "https://api.welcomesoftware.com/v3/images/5d7f910551b00a722e0418830cee2213"
}
}],
"videos": [{
"id": "5d7f910551b00a722e0418830cee2214",
"links": {
"self": "https://api.welcomesoftware.com/v3/videos/5d7f910551b00a722e0418830cee2214"
}
}],
"raw_files": [{
"id": "5d7f910551b00a722e0418830cee2215",
"links": {
"self": "https://api.welcomesoftware.com/v3/raw-files/5d7f910551b00a722e0418830cee2215"
}
}]
},
"publishing_event": {
"id": "5d7f910551b00a722e0418830cee5534",
"links": {
"self": "https://api.welcomesoftware.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534",
"publishing_metadata": "https://api.welcomesoftware.com/v3/publishing-events/5d7f910551b00a722e0418830cee5534/publishing-metadata"
}
},
"organization": {
"id": "5d75447b7f1c1c000957d362"
}
}
}
Updated 10 days ago