logoEventCatalog

SendAppMessage
v1.0.0

An event raised when a service wants to send a message to consumer app.

Properties

id* :

Unique identifier of message

userId* :

Id of the user who wanna be notified

name* :

Message name so that app knows how to handle it eg: "LOYALTY_POINTS_EARNED"

data* :

this can be any object this will be the payload of the message that will be sent to the app eg: { "points": 100 } for LOYALTY_POINTS_EARNED message

SendAppMessage Schema (yml)
openapi: 3.0.0
info:
  version: "1.0.0"
  title: SendAppMessage
paths: {}
components:
  schemas:
    SendAppMessage:
      type: object
      required:
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Metadata:
      type: object
      properties:
        version:
          type: string
      required:
        - version
    Data:
      type: object
      properties:
        id:
          type: string
        userId:
          type: string
        name:
          type: string
        data:
          type: object
      required:
        - id
        - userId
        - name
        - data
Edit this pageLast updated on 2024/4/2