Sync: holydocs/messageflow-source-workflow-example @ 9e9f570ddaed2c71314d7588dc686e5f82100206

Author: messageflow-ci-bot

deps/holydocs/messageflow-source-workflow-example/campaign.asyncapi.yaml

@@ -4,19 +4,35 @@
 
 - [Context](#context)
 - [Services](#services)
+  - [Campaign Service](#campaign-service)
   - [User Service](#user-service)
 - [Channels](#channels)
+  - [campaign.analytics](#campaignanalytics)
+  - [campaign.create](#campaigncreate)
+  - [campaign.execute](#campaignexecute)
+  - [campaign.status](#campaignstatus)
   - [notification.preferences.update](#notificationpreferencesupdate)
+  - [notification.user.{user_id}.push](#notificationuseruseridpush)
   - [user.analytics](#useranalytics)
   - [user.info.request](#userinforequest)
   - [user.info.update](#userinfoupdate)
+- [Changelog](#changelog)
 
 ## Context
 
 ![Context](diagrams/context.svg)
 
 ## Services
 
+### Campaign Service
+
+A service that manages notification campaigns, user targeting, and campaign execution.
+Handles campaign creation, user segmentation, scheduling, and personalized notification delivery.
+Uses user data for targeting and personalization of campaign messages.
+
+
+![Campaign Service Service Channels](diagrams/service_campaign-service.svg)
+
 ### User Service
 
 A service that manages user information, profiles, and authentication.
@@ -27,6 +43,160 @@ Handles user data requests, profile updates, and user lifecycle events.
 
 ## Channels
 
+### campaign.analytics
+
+![campaign.analytics Channel Services](diagrams/channel_campaignanalytics.svg)
+
+#### Messages
+**CampaignAnalyticsEventMessage**
+```json
+{
+  "campaign_id": "string[uuid]",
+  "event_id": "string[uuid]",
+  "event_type": "string[enum:campaign_created,campaign_executed,notification_sent,notification_opened,notification_clicked,campaign_completed,campaign_failed]",
+  "execution_id": "string[uuid]",
+  "metadata": {
+    "environment": "string[enum:development,staging,production]",
+    "platform": "string[enum:ios,android,web]",
+    "source": "string[enum:mobile,web,api]",
+    "version": "string"
+  },
+  "notification_id": "string[uuid]",
+  "timestamp": "string[date-time]",
+  "user_id": "string[uuid]"
+}
+```
+
+### campaign.create
+
+![campaign.create Channel Services](diagrams/channel_campaigncreate.svg)
+
+#### Messages
+**CampaignCreateMessage**
+```json
+{
+  "campaign_id": "string[uuid]",
+  "created_at": "string[date-time]",
+  "description": "string",
+  "metadata": {
+    "environment": "string[enum:development,staging,production]",
+    "platform": "string[enum:ios,android,web]",
+    "source": "string[enum:mobile,web,api]",
+    "version": "string"
+  },
+  "name": "string",
+  "notification_template": {
+    "body_template": "string",
+    "data": "object",
+    "localization": "object",
+    "priority": "string[enum:low,normal,high]",
+    "title_template": "string"
+  },
+  "schedule": {
+    "recurring": {
+      "end_date": "string[date]",
+      "frequency": "string[enum:daily,weekly,monthly]",
+      "interval": "integer",
+      "start_date": "string[date]"
+    },
+    "scheduled_at": "string[date-time]",
+    "timezone": "string",
+    "type": "string[enum:immediate,scheduled,recurring]"
+  },
+  "settings": {
+    "a_b_testing": {
+      "enabled": "boolean",
+      "traffic_split": [
+        "number"
+      ],
+      "variants": [
+        {
+          "body_template": "string",
+          "data": "object",
+          "localization": "object",
+          "priority": "string[enum:low,normal,high]",
+          "title_template": "string"
+        }
+      ]
+    },
+    "batch_size": "integer",
+    "max_retries": "integer",
+    "rate_limit": "integer",
+    "respect_quiet_hours": "boolean"
+  },
+  "target_audience": {
+    "estimated_reach": "integer",
+    "user_filters": {
+      "language": [
+        "string"
+      ],
+      "last_activity": {
+        "from": "string[date-time]",
+        "to": "string[date-time]"
+      },
+      "registration_date": {
+        "from": "string[date]",
+        "to": "string[date]"
+      },
+      "timezone": [
+        "string"
+      ]
+    },
+    "user_segments": [
+      "string[enum:all_users,new_users,active_users,inactive_users,premium_users,free_users]"
+    ]
+  }
+}
+```
+
+### campaign.execute
+
+![campaign.execute Channel Services](diagrams/channel_campaignexecute.svg)
+
+#### Messages
+**CampaignExecuteMessage**
+```json
+{
+  "batch_size": "integer",
+  "campaign_id": "string[uuid]",
+  "created_at": "string[date-time]",
+  "execution_id": "string[uuid]",
+  "execution_type": "string[enum:immediate,scheduled,batch]",
+  "metadata": {
+    "environment": "string[enum:development,staging,production]",
+    "platform": "string[enum:ios,android,web]",
+    "source": "string[enum:mobile,web,api]",
+    "version": "string"
+  },
+  "priority": "string[enum:low,normal,high]"
+}
+```
+
+### campaign.status
+
+![campaign.status Channel Services](diagrams/channel_campaignstatus.svg)
+
+#### Messages
+**CampaignStatusUpdateMessage**
+```json
+{
+  "campaign_id": "string[uuid]",
+  "error": {
+    "code": "string",
+    "message": "string"
+  },
+  "execution_id": "string[uuid]",
+  "progress": {
+    "failed": "integer",
+    "sent": "integer",
+    "success_rate": "number[float]",
+    "total_targets": "integer"
+  },
+  "status": "string[enum:pending,running,completed,failed,paused,cancelled]",
+  "updated_at": "string[date-time]"
+}
+```
+
 ### notification.preferences.update
 
 ![notification.preferences.update Channel Services](diagrams/channel_notificationpreferencesupdate.svg)
@@ -55,6 +225,24 @@ Handles user data requests, profile updates, and user lifecycle events.
 }
 ```
 
+### notification.user.{user_id}.push
+
+![notification.user.{user_id}.push Channel Services](diagrams/channel_notificationuseruseridpush.svg)
+
+#### Messages
+**PushNotificationMessage**
+```json
+{
+  "body": "string",
+  "created_at": "string[date-time]",
+  "data": "object",
+  "notification_id": "string[uuid]",
+  "priority": "string[enum:low,normal,high]",
+  "title": "string",
+  "user_id": "string[uuid]"
+}
+```
+
 ### user.analytics
 
 ![user.analytics Channel Services](diagrams/channel_useranalytics.svg)
@@ -121,3 +309,8 @@ Handles user data requests, profile updates, and user lifecycle events.
   "user_id": "string[uuid]"
 }
 ```
+
+## Changelog
+
+### 2025-07-26
+- **added** service: 'Campaign Service' was added