Edit in GitHubLog an issue

Receiving Events

When Cloud Manager emits an event, all webhooks configured for that event will be called. As it is possible to reuse the same webhook for multiple events and even multiple events from different providers, webhooks should inspect the event payload in order to determine the nature of the event before handling it. This can be done by using the @type and xdmEventEnvelope:objectType values. The @type value identifies the verb, i.e. the thing that happened, whereas the xdmEventEnvelope:objectType value identifies the noun, i.e. what type of thing the thing that happened happened to.

Event Types#

Pipeline Execution Started#

@type
https://ns.adobe.com/experience/cloudmanager/event/started
xdmEventEnvelope:objectType
https://ns.adobe.com/experience/cloudmanager/pipeline-execution

Pipeline Execution Step Started#

@type
https://ns.adobe.com/experience/cloudmanager/event/started
xdmEventEnvelope:objectType
https://ns.adobe.com/experience/cloudmanager/execution-step-state

Pipeline Execution Step Waiting#

@type
https://ns.adobe.com/experience/cloudmanager/event/waiting
xdmEventEnvelope:objectType
https://ns.adobe.com/experience/cloudmanager/execution-step-state

Pipeline Execution Step Ended#

@type
https://ns.adobe.com/experience/cloudmanager/event/ended
xdmEventEnvelope:objectType
https://ns.adobe.com/experience/cloudmanager/execution-step-state

Pipeline Execution Ended#

@type
https://ns.adobe.com/experience/cloudmanager/event/ended
xdmEventEnvelope:objectType
https://ns.adobe.com/experience/cloudmanager/pipeline-execution

The body of the requests received by the webhook will vary based on the event type. The Reference Document details the schema for each event body.

Step Actions#

Each pipeline step has an assigned action which indicates the type of step. New actions will be added over time. Below is the list of actions in the current release:

action valueDescription
validatePipeline and Environment Validation
buildBuild and Unit Testing
codeQualityCode Quality Testing
buildImageBuild Image from branch source
securityTestSecurity Testing
loadTestSites Performance Testing Execution
assetsTestAssets Performance Testing Execution
reportPerformanceTestAssets Performance Testing Execution
productTestProduct Functional Tests
functionalTestCustom Functional Tests
contentAuditExperience Audit (fka Content Audit)
approvalGo-Live Approval
scheduleProduction Deployment Scheduling
managedCSE Oversight
deployDeployment

Step Events#

With a few exceptions, all steps will emit start and end events. The waiting event is emitted when a step is waiting for user feedback, e.g. when important metrics have failed and the pipeline is waiting for a decision to override or reject those failures. There are some exceptions, however. These actions will never emit start events:

  • codeQuality
  • approval
  • schedule
  • managed

Validating Events#

Webhooks used in Adobe I/O must be accessible from the public internet. As a result, it is a best practice to use the x-adobe-signature header to validate that the event did, in fact, originate from Adobe I/O. Information on this header can be found in the Authenticating events section of the Adobe I/O Events Webhooks Introduction.

  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.