Webhook payloads

This page contains sample payloads for each of the webhook events currently supported by Dynamic Content. This information will be useful to you if you're developing a webhook integration, particularly when adding filters and creating custom payloads.

For information about customizing a webhook payload see custom payloads.

The payload in each webhook event will contain the ID of the item the event applies to. For example, the edition ID for a scheduled, unscheduled, or published edition and the content ID for the content created, updated or status updated events.

Also included in each payload is a set of HAL links, which you can follow for common actions related to the edition, content item or snapshot.

See the Dynamic Content Management API reference for more information about how you can make use of the information included in the payload.

Edition scheduled

This webhook event is triggered when an edition is scheduled in Dynamic Content. The payload will include:

  • the name of the edition and any comments added
  • the start and end date of the edition
  • the ID of the event that the edition is part of
  • activeEndDate: true if content is marked to expire at the edition's end date
{  
   "sequenceId":1,
   "id":"704ffd56-cb61-43f0-8734-4bd4fbb1c772",
   "name":"dynamic-content.edition.scheduled",
   "requestId":"a7f9d7eb-a109-41a6-b79f-2618cd28ac3b",
   "resource":"5cf679244cedfd000109d2ef",
   "payload":{  
      "id":"5ddeb27d4cedfd0001c66dee",
      "name":"November Launch edition",
      "comment":"",
      "start":"2019-11-28T00:00:00.000Z",
      "end":"2019-11-30T23:59:59.999Z",
      "eventId":"5ddeb273cff47e0001800275",
      "publishingStatus":"SCHEDULED",
      "slotsRemaining":198,
      "schedulingErrors":[  

      ],
      "activeEndDate":false,
      "publishingJobId":"5ddeb2d64cedfd0001c66e02",
      "publishManifestId":"5ddeb2d54cedfd0001c66e01",
      "statusUpdated":"2019-11-27T17:29:33.874Z",
      "lastPublishingEventDate":"2019-11-27T17:31:09.076Z",
      "schedulingUser":"200827cd-f51c-4d3e-bb50-87623d1c5768",
      "createdBy":"200827cd-f51c-4d3e-bb50-87623d1c5768",
      "createdDate":"2019-11-27T17:29:33.875Z",
      "lastModifiedBy":"200827cd-f51c-4d3e-bb50-87623d1c5768",
      "lastModifiedDate":"2019-11-27T17:31:02.078Z",
      "stagedDate":null,
      "slotCollisions":false,
      "_links":{  
         "self":{  
            "href":"https://api.amplience.net/v2/content/editions/5ddeb27d4cedfd0001c66dee"
         },
         "edition":{  
            "href":"https://api.amplience.net/v2/content/editions/5ddeb27d4cedfd0001c66dee"
         }
      }
   }
}

Edition unscheduled

This web hook event is triggered when an edition is unscheduled. The payload will include:

  • the name of the edition and any comments
  • the publishing status: for an unscheduled edition this will be set back to Draft
  • the start and end date of the edition
  • the ID of the event that the edition is part of
  • activeEndDate: true if content is marked to expire at the edition's end date
{  
   "sequenceId":1,
   "id":"cd403c48-51d4-4183-8530-6967dd892104",
   "name":"dynamic-content.edition.unscheduled",
   "requestId":"0ec0d59b-bfa1-4e9e-add4-28739c825e53",
   "resource":"5cf679244cedfd000109d2ef",
   "payload":{  
      "id":"5ddeb27d4cedfd0001c66dee",
      "name":"November Launch edition",
      "comment":"",
      "start":"2019-11-28T00:00:00.000Z",
      "end":"2019-11-30T23:59:59.999Z",
      "eventId":"5ddeb273cff47e0001800275",
      "publishingStatus":"DRAFT",
      "slotsRemaining":198,
      "schedulingErrors":[  

      ],
      "activeEndDate":false,
      "publishingJobId":null,
      "statusUpdated":"2019-11-27T17:29:33.874Z",
      "lastPublishingEventDate":"2019-11-27T17:33:27.591Z",
      "schedulingUser":"200827cd-f51c-4d3e-bb50-87623d1c5768",
      "createdBy":"200827cd-f51c-4d3e-bb50-87623d1c5768",
      "createdDate":"2019-11-27T17:29:33.875Z",
      "lastModifiedBy":"200827cd-f51c-4d3e-bb50-87623d1c5768",
      "lastModifiedDate":"2019-11-27T17:33:27.386Z",
      "stagedDate":null,
      "slotCollisions":false,
      "_links":{  
         "self":{  
            "href":"https://api.amplience.net/v2/content/editions/5ddeb27d4cedfd0001c66dee"
         },
         "edition":{  
            "href":"https://api.amplience.net/v2/content/editions/5ddeb27d4cedfd0001c66dee"
         }
      }
   }
}

Snapshot published

The Snapshot published webhook event is triggered in two ways: when a content item is published and when an edition is published on its start date. The information in the payload will vary according to how it was triggered.

The "createdFrom" field in the payload will indicate whether the webhook event was triggered when a content item was published or when an edition was published. For content items, "createdFrom" will be set to "content-item" and for editions it will be set to "edition".

Snapshot published when content item published

For the Snapshot published event triggered when a content item published, the payload will include:

  • the content item ID
  • the creation and modification date
  • the content type URI of the root content item
  • the content item label
  • the content item's locale (if one is set)
  • the createdFrom field will be set to "content-item"
{
  "sequenceId": 1,
  "id": "9f263950-3242-43bf-8b6c-33ddc589bc7c",
  "name": "dynamic-content.snapshot.published",
  "requestId": "d8f47152-9f25-43e4-986b-d3390429db0c",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "5ddeb715cff47e000185c03d",
    "comment": "Publish Manifest for content item woman-in-scarf",
    "createdDate": "2019-11-27T17:49:09.448Z",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "createdFrom": "content-item",
    "type": "SYSTEM",
    "meta": [],
    "taggedEditions": [],
    "locale": null,
    "rootContentItem": {
      "label": "Woman in scarf",
      "contentTypeUri": "http://docexample.carouselslide.json",
      "id": "ee68180d-41cd-4374-af85-b4fa1acf8f56"
    },
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/snapshots/5ddeb715cff47e000185c03d"
      },
      "snapshot": {
        "href": "https://api.amplience.net/v2/content/snapshots/5ddeb715cff47e000185c03d"
      }
    }
  }
}

Snapshot published when edition published

For the Snapshot published event triggered when an edition is published on its start date, the payload will include:

  • the ID of the published edition
  • the edition creation date
  • created from will be set to "edition"
  • rootContentItems contains an array of the top level slots contained in the edition that has been published
{
  "sequenceId": 82,
  "id": "c64232af-9bdf-4e7c-b999-8538bc8203e1",
  "name": "dynamic-content.snapshot.published",
  "requestId": "6a1fe9b3-7940-4515-a16b-330e9ac085b6",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "5e6a483e52faff00016c6ab0",
    "comment": "Publish Manifest for edition Mad march free shipping promotion",
    "createdDate": "2020-03-12T14:33:34.472Z",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "createdFrom": "edition",
    "type": "SYSTEM",
    "meta": null,
    "taggedEditions": null,
    "locale": null,
    "rootContentItem": null,
    "rootContentItems": [
      {
        "label": "home-page-feature-slot",
        "contentTypeUri": "http://docexample.com/tutorialbannerslot.json",
        "id": "5d69bdef-df0b-4680-acfc-0bdaa2a82bed"
      },
      {
        "label": "Spring Banner slot",
        "contentTypeUri": "http://docexample.com/tutorialbannerslot.json",
        "id": "3e1f5840-251e-4658-a5b0-7f82efb2530d"
      }
    ],
    "publishedEdition": {
      "asOf": "2020-03-12T14:37:00Z"
    },
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/snapshots/5e6a483e52faff00016c6ab0"
      },
      "snapshot": {
        "href": "https://api.amplience.net/v2/content/snapshots/5e6a483e52faff00016c6ab0"
      }
    }
  }
}

Edition published

The edition published webhook event is triggered when an edition is published on its start date. The payload will include:

  • The edition ID
  • The edition name, comment, start and end date
  • The edition last modified date and the user that modified it

The HAL links will include the API calls to get more information about the published edition.

{
  "sequenceId": 1,
  "id": "8381a876-e781-495b-9fe9-f890b624010f",
  "name": "dynamic-content.edition.published",
  "requestId": "dea1c72c-dfe3-44e7-89b1-ac095f867e67",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "5ddeb27d4cedfd0001c66dee",
    "name": "November Launch edition",
    "comment": "",
    "start": "2019-11-27T17:53:00.000Z",
    "end": "2019-11-30T23:59:59.999Z",
    "eventId": "5ddeb273cff47e0001800275",
    "publishingStatus": "PUBLISHED",
    "slotsRemaining": 198,
    "schedulingErrors": [],
    "activeEndDate": false,
    "publishingJobId": "5ddeb7834cedfd0001d70e05",
    "publishManifestId": "5ddeb7834cedfd0001d70e04",
    "statusUpdated": "2019-11-27T17:29:33.874Z",
    "lastPublishingEventDate": "2019-11-27T17:53:07.477Z",
    "schedulingUser": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "createdDate": "2019-11-27T17:29:33.875Z",
    "lastModifiedBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "lastModifiedDate": "2019-11-27T17:50:59.433Z",
    "stagedDate": null,
    "slotCollisions": false,
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/editions/5ddeb27d4cedfd0001c66dee"
      },
      "edition": {
        "href": "https://api.amplience.net/v2/content/editions/5ddeb27d4cedfd0001c66dee"
      }
    }
  }
}

Content item created

This webhook event is triggered when a content item is created in Dynamic Content. The payload includes the following:

  • the content ID
  • the content body for the created item. As shown in the example payload below, it will also include any linked items
  • the item version
  • the creation and modification dates and who created and modified the item
  • the folder id and label for the folder within which the item is stored
  • the repository id and label for the repository within which the item is stored
  • the workflow status and label if one is set
  • the item's locale if one is set
  • the ids of any assignees
{
  "sequenceId": 31,
  "id": "9eda6be2-f4bd-4ab8-9bd3-fc01efb73e76",
  "name": "dynamic-content.content-item.created",
  "requestId": "bbff1ac7-7910-4cfa-8ec0-db7f8b9c975c",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "2d9871c5-01bc-4a85-b6d9-1c0baa1607cc",
    "contentRepositoryId": "5cf6792e4cedfd0001885b67",
    "workflow": {
      "state": "5ddea64ecff47e00017fffa0"
    },
    "folderId": "5ddeaf09c9e77c000137e2f1",
    "body": {
      "_meta": {
        "name": "spring-carousel",
        "schema": "http://example.com/carousel.json"
      },
      "slides": [
        {
          "_meta": {
            "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
          },
          "contentType": "http://example.com/carouselslide.json",
          "id": "b848b43e-6e7f-482e-b652-cb076b6a9bb2"
        },
        {
          "_meta": {
            "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
          },
          "contentType": "http://example.com/carouselslide.json",
          "id": "da105865-fddc-4e3b-88eb-f7aaf11db860"
        },
        {
          "_meta": {
            "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
          },
          "contentType": "http://example.com/carouselslide.json",
          "id": "903f32d0-bc49-4398-948c-e53eac818909"
        },
        {
          "_meta": {
            "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
          },
          "contentType": "http://example.com/carouselslide.json",
          "id": "4acc9fac-d075-42a9-bf76-61055e0fdf59"
        }
      ]
    },
    "version": 1,
    "label": "Spring carousel",
    "status": "ACTIVE",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "locale": "fr-FR",
    "createdDate": "2020-03-04T16:34:50.262Z",
    "lastModifiedBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "lastModifiedDate": "2020-03-04T16:34:50.262Z",
    "assignees": [
      "200827cd-f51c-4d3e-bb50-87623d1c5768"
    ],
    "assignedDate": "2020-03-04T16:34:50.187Z",
    "repositoryLabel": "Content",
    "workflowStatusLabel": "Draft",
    "folderName": "My content folder",
    "deliveryId": "2d9871c5-01bc-4a85-b6d9-1c0baa1607cc",
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/content-items/2d9871c5-01bc-4a85-b6d9-1c0baa1607cc"
      },
      "content-item": {
        "href": "https://api.amplience.net/v2/content/content-items/2d9871c5-01bc-4a85-b6d9-1c0baa1607cc{?projection}",
        "templated": true
      }
    }
  }
}

Content item updated

This webhook event is triggered when a content item a change is made to a content item and the item is saved. The payload includes the following:

  • the content ID
  • the content body for the updated item. This will also include any linked items
  • the item version
  • the creation and modification dates and who created and modified the item
  • the folder id and label for the folder within which the item is stored
  • the repository id and label for the repository within which the item is stored
  • the workflow state and label if one is set
  • the item's locale if one is set
  • the ids of any assignees
{
  "sequenceId": 111,
  "id": "16cfd8ad-9170-497e-8115-63ad9a164dc7",
  "name": "dynamic-content.content-item.updated",
  "requestId": "7be98571-9b44-473b-9fbb-b2593511024f",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "eefaf401-9551-41dd-aa5e-a5362990b1b7",
    "contentRepositoryId": "5cf6792e4cedfd0001885b67",
    "workflow": {
      "state": "5ddea642cff47e0001cf23a9"
    },
    "folderId": "5ddeaf09c9e77c000137e2f1",
    "body": {
      "_meta": {
        "name": "spring-banner",
        "schema": "http://docexample.com/tutorialbanner.json"
      },
      "background": {
        "_meta": {
          "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/image-link"
        },
        "id": "499ceb10-18dc-48be-baa7-306f938928cd",
        "name": "womaninfield",
        "endpoint": "ampproduct",
        "defaultHost": "i1.adis.ws"
      },
      "headline": "Get ready for Spring",
      "strapline": "It will be here before you know it",
      "calltoactiontext": "Visit our Spring Collection",
      "calltoactionurl": "http://www.example.com/spring"
    },
    "version": 7,
    "label": "Spring banner",
    "status": "ACTIVE",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "locale": "fr-FR",
    "createdDate": "2019-11-27T17:16:18.948Z",
    "lastModifiedBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "lastModifiedDate": "2020-03-04T16:06:13.984Z",
    "lastPublishedVersion": 4,
    "lastPublishedDate": "2020-03-04T13:19:22.595Z",
    "assignees": [
      "1c9409a4-2f19-4f3a-932a-01af19fa112b",
      "04939ebd-2ca7-4287-8628-e018e3651d7b"
    ],
    "assignedDate": "2020-03-04T16:06:03.415Z",
    "repositoryLabel": "Content",
    "workflowStatusLabel": "In Review",
    "folderName": "My content folder",
    "deliveryId": "eefaf401-9551-41dd-aa5e-a5362990b1b7",
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/content-items/eefaf401-9551-41dd-aa5e-a5362990b1b7"
      },
      "content-item": {
        "href": "https://api.amplience.net/v2/content/content-items/eefaf401-9551-41dd-aa5e-a5362990b1b7{?projection}",
        "templated": true
      }
    }
  }

Content item workflow updated

This webhook event is triggered when a content item's status is added or updated. The payload will include:

  • the id of the content item for which the status has been updated
  • the new workflow state id and label
  • the content tree for the item updated
  • the content item version (changing the status does not create a new version)
  • the folder id and label for the folder within which the item is stored
  • the repository id and label for the repository within which the item is stored
  • the item's locale if one is set
  • the ids of any assignees
{
  "sequenceId": 3,
  "id": "a7beabb3-528c-422a-948a-b356b24f2af4",
  "name": "dynamic-content.content-item.workflow.updated",
  "requestId": "af4b5ce4-a42c-4fa0-894b-c21212efc959",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "eefaf401-9551-41dd-aa5e-a5362990b1b7",
    "contentRepositoryId": "5cf6792e4cedfd0001885b67",
    "workflow": {
      "state": "5ddea6344cedfd0001d70a44"
    },
    "folderId": "5ddeaf09c9e77c000137e2f1",
    "body": {
      "_meta": {
        "name": "spring-banner",
        "schema": "http://docexample.com/tutorialbanner.json"
      },
      "background": {
        "_meta": {
          "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/image-link"
        },
        "id": "499ceb10-18dc-48be-baa7-306f938928cd",
        "name": "womaninfield",
        "endpoint": "ampproduct",
        "defaultHost": "i1.adis.ws"
      },
      "headline": "Get ready for Spring",
      "strapline": "It will be here before you know it",
      "calltoactiontext": "Visit our Spring Collection",
      "calltoactionurl": "http://www.example.com/spring"
    },
    "version": 7,
    "label": "Spring banner",
    "status": "ACTIVE",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "locale": "fr-FR",
    "createdDate": "2019-11-27T17:16:18.948Z",
    "lastModifiedBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "lastModifiedDate": "2020-03-04T16:13:20.272Z",
    "lastPublishedVersion": 4,
    "lastPublishedDate": "2020-03-04T13:19:22.595Z",
    "assignees": [
      "1c9409a4-2f19-4f3a-932a-01af19fa112b",
      "04939ebd-2ca7-4287-8628-e018e3651d7b"
    ],
    "assignedDate": "2020-03-04T16:06:03.415Z",
    "repositoryLabel": "Content",
    "workflowStatusLabel": "Approved",
    "folderName": "My content folder",
    "deliveryId": "eefaf401-9551-41dd-aa5e-a5362990b1b7",
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/content-items/eefaf401-9551-41dd-aa5e-a5362990b1b7"
      },
      "content-item": {
        "href": "https://api.amplience.net/v2/content/content-items/eefaf401-9551-41dd-aa5e-a5362990b1b7{?projection}",
        "templated": true
      }
    }
  }

Content item assignee updated

This webhook event is triggered when the assignees of a content item are added or updated.

The payload will include:

  • the ID of the content item for which the assignees have been updated
  • the current assignees (these are the assignee IDs)
  • the previous assignees (these are the assignee IDs)
  • the content tree for the item updated
  • the content item version (changing the assignee does not create a new version)
{
  "sequenceId": 1,
  "id": "fe746c02-f682-4792-87ed-1eafc229c194",
  "name": "dynamic-content.content-item.assigned",
  "requestId": "2f3ea8b0-dd94-4805-b020-e66cd7af238c",
  "resource": "5cf679244cedfd000109d2ef",
  "payload": {
    "id": "eefaf401-9551-41dd-aa5e-a5362990b1b7",
    "contentRepositoryId": "5cf6792e4cedfd0001885b67",
    "folderId": "5ddeaf09c9e77c000137e2f1",
    "body": {
      "_meta": {
        "name": "spring-banner",
        "schema": "http://docexample.com/tutorialbanner.json"
      },
      "background": {
        "_meta": {
          "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/image-link"
        },
        "id": "499ceb10-18dc-48be-baa7-306f938928cd",
        "name": "womaninfield",
        "endpoint": "ampproduct",
        "defaultHost": "i1.adis.ws"
      },
      "headline": "Get ready for Spring",
      "strapline": "It will be here before you know it!",
      "calltoactiontext": "Visit our Spring Collection",
      "calltoactionurl": "http://www.example.com/spring"
    },
    "version": 4,
    "label": "Spring banner",
    "status": "ACTIVE",
    "createdBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "createdDate": "2019-11-27T17:16:18.948Z",
    "lastModifiedBy": "200827cd-f51c-4d3e-bb50-87623d1c5768",
    "lastModifiedDate": "2020-03-04T13:05:33.283Z",
    "lastPublishedVersion": 3,
    "lastPublishedDate": "2020-03-02T10:30:43.195Z",
    "assignees": [
      "1c9409a4-2f19-4f3a-932a-01af19fa112b",
      "200827cd-f51c-4d3e-bb50-87623d1c5768"
    ],
    "assignedDate": "2020-03-04T13:05:33.274Z",
    "previousAssignees": [
      "1c9409a4-2f19-4f3a-932a-01af19fa112b"
    ],
    "deliveryId": "eefaf401-9551-41dd-aa5e-a5362990b1b7",
    "_links": {
      "self": {
        "href": "https://api.amplience.net/v2/content/content-items/eefaf401-9551-41dd-aa5e-a5362990b1b7"
      },
      "content-item": {
        "href": "https://api.amplience.net/v2/content/content-items/eefaf401-9551-41dd-aa5e-a5362990b1b7{?projection}",
        "templated": true
      }
    }
  }
}

Custom payloads

results matching ""

    No results matching ""