Cloud Custodian · AsyncAPI Specification
Cloud Custodian c7n-mailer Notification Events
Version 1.0.0
The Cloud Custodian c7n-mailer AsyncAPI defines the event-driven notification interface used by the Cloud Custodian policy engine to deliver policy violation alerts. When a policy's notify action fires, the Custodian runtime encodes a structured message payload and publishes it to an AWS SQS queue. The c7n-mailer daemon dequeues these messages and delivers notifications via email (SES), Slack, DataDog, Splunk, or webhook endpoints. Messages are base64-encoded, gzip-compressed JSON identified by the maidmsg/1.0 message type.
View Spec
View on GitHub
Cloud SecurityComplianceCost OptimizationMulti-CloudPolicy as CodeAsyncAPIWebhooksEvents
Channels
/policy-notification
Publish Policy Notification
Channel through which Cloud Custodian publishes policy violation notification messages. Each message describes the policy that matched, the resources that were affected, and the account context. The c7n-mailer subscribes to this channel to deliver alerts to operators.
Messages
PolicyNotification
Cloud Custodian Policy Notification
A notification message emitted by a Cloud Custodian policy notify action describing the matched resources and execution context.
Servers
https
aws-sqs
https://sqs.{region}.amazonaws.com/{account-id}/{queue-name}
AWS SQS queue that receives policy notification messages from Cloud Custodian notify actions. The c7n-mailer daemon polls this queue and processes messages for delivery to configured notification channels.