Skip to content
On this page

Notifications

INFO

This page will describe how notifications can be generated.

Examples

Notification

yaml
arch: 1.0.0
definitions:
  notifications:
    OrderShipped:
      subject: Order Shipped

Notification With Constructor

yaml
arch: 1.0.0
definitions:
  notifications:
    OrderShippedWithConstructor:
      subject: Order Shipped
      metadata:
        constructor:
          properties:
            key: string

Queued

yaml
arch: 1.0.0
definitions:
  notifications:
    OrderShippedQueued:
      subject: Order Shipped
      shouldQueue: true

Markdown

yaml
arch: 1.0.0
definitions:
  notifications:
    OrderShippedWithMarkdown:
      subject: Order Shipped
      shouldBeMarkdown: true

Markdown Queued

yaml
arch: 1.0.0
definitions:
  notifications:
    OrderShippedWithMarkdownQueued:
      subject: Order Shipped
      shouldQueue: true
      shouldBeMarkdown: true