Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(architecture): match the webhook payload diagram to the wire
Yudhi Armyndharis8fe092c5572c
diff --git a/docs/03-system-architecture.md b/docs/03-system-architecture.mdindex d05c5606c..85e5859a3 100644--- a/docs/03-system-architecture.md+++ b/docs/03-system-architecture.md@@ -545,19 +545,20 @@ classDiagramclass WebhookPayload {+event: EventType- +timestamp: Date+ +timestamp: string+sessionId: string- +data: any- +signature: string+ +idempotencyKey: string+ +deliveryId: string+ +data: object}class EventType {<<enumeration>>- MESSAGE_RECEIVED- MESSAGE_SENT- MESSAGE_ACK- SESSION_STATUS- QR_CODE+ message.received+ message.sent+ message.ack+ session.status+ session.qr}WebhookManager --> Webhook@@ -565,6 +566,10 @@ classDiagramWebhook --> EventType```+`timestamp` is an ISO 8601 string. The body carries no signature: when the webhook has a secret, the+HMAC travels in the `X-OpenWA-Signature: sha256=<hex>` header. `EventType` shows a few of the dotted+event names; `WEBHOOK_EVENTS` in `src/modules/webhook/dto/webhook.dto.ts` is the full list.+## 3.6 Data Flow Diagrams### 3.6.1 Send Message Flow