@ingenx-io/valets-schema-mcp-server 0.1.10 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/docs/collections/firestore-paths.md +20 -0
- package/data/docs/enums/attention-status.md +1 -1
- package/data/docs/enums/booking-status.md +1 -1
- package/data/docs/enums/customer-payment-status.md +1 -1
- package/data/docs/enums/customer-payment-target-type.md +1 -1
- package/data/docs/enums/delivery-type.md +1 -1
- package/data/docs/enums/deployment-link-type.md +1 -1
- package/data/docs/enums/event-status.md +1 -1
- package/data/docs/enums/fulfillment-status.md +1 -1
- package/data/docs/enums/loyalty-transaction-type.md +1 -1
- package/data/docs/enums/order-status.md +1 -1
- package/data/docs/enums/outbound-message-format.md +22 -0
- package/data/docs/enums/outbound-message-purpose.md +24 -0
- package/data/docs/enums/outbound-message-status.md +4 -4
- package/data/docs/enums/payment-method.md +2 -2
- package/data/docs/enums/payment-proof-status.md +2 -2
- package/data/docs/enums/payment-status.md +2 -2
- package/data/docs/enums/pending-issue.md +2 -2
- package/data/docs/enums/return-status.md +2 -2
- package/data/docs/enums/session-status.md +2 -2
- package/data/docs/enums/site-status.md +2 -2
- package/data/docs/enums/stocktake-frequency.md +2 -2
- package/data/docs/enums/stocktake-item-status.md +2 -2
- package/data/docs/enums/stocktake-status.md +2 -2
- package/data/docs/enums/ticket-status.md +2 -2
- package/data/docs/enums/waba-label.md +2 -2
- package/data/docs/enums/whatsapp-template-status.md +26 -0
- package/data/docs/index.md +9 -5
- package/data/docs/models/allowed-user.md +1 -1
- package/data/docs/models/analytics-backfill.md +1 -1
- package/data/docs/models/analytics-daily.md +1 -1
- package/data/docs/models/analytics-event.md +1 -1
- package/data/docs/models/analytics-hourly.md +1 -1
- package/data/docs/models/booking-version.md +1 -1
- package/data/docs/models/booking.md +1 -1
- package/data/docs/models/customer-payment-allocation.md +1 -1
- package/data/docs/models/customer-payment.md +1 -1
- package/data/docs/models/customer.md +1 -1
- package/data/docs/models/event.md +1 -1
- package/data/docs/models/loyalty-config.md +1 -1
- package/data/docs/models/loyalty-reward.md +1 -1
- package/data/docs/models/loyalty-status.md +1 -1
- package/data/docs/models/loyalty-transaction.md +1 -1
- package/data/docs/models/magic-link-request.md +1 -1
- package/data/docs/models/metrics-current.md +1 -1
- package/data/docs/models/metrics-daily.md +1 -1
- package/data/docs/models/metrics-monthly.md +1 -1
- package/data/docs/models/order-item.md +1 -1
- package/data/docs/models/order.md +1 -1
- package/data/docs/models/sale.md +1 -1
- package/data/docs/models/site-payment.md +1 -1
- package/data/docs/models/site.md +1 -1
- package/data/docs/models/stocktake-item.md +1 -1
- package/data/docs/models/stocktake.md +1 -1
- package/data/docs/models/ticket.md +1 -1
- package/data/docs/models/whatsapp-inbound-message.md +1 -1
- package/data/docs/models/whatsapp-outbound-lifecycle-event.md +310 -0
- package/data/docs/models/whatsapp-outbound-message.md +395 -172
- package/data/docs/models/whatsapp-template.md +177 -0
- package/data/static/llms.txt +110 -32
- package/data/static/openapi.yaml +274 -66
- package/data/static/schemas.json +354 -69
- package/package.json +1 -1
- package/data/docs/enums/outbound-message-kind.md +0 -23
|
@@ -313,7 +313,7 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
313
313
|
**Description:** (Immutable, Denormalized) From User display name at creation time.
|
|
314
314
|
|
|
315
315
|
----------------------------------------------------------------------------------------------------------------------------
|
|
316
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
316
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
317
317
|
|
|
318
318
|
:::info Immutable
|
|
319
319
|
Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
|
|
@@ -282,4 +282,4 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
282
282
|
| **Required** | No |
|
|
283
283
|
|
|
284
284
|
----------------------------------------------------------------------------------------------------------------------------
|
|
285
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
285
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
@@ -525,7 +525,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
525
525
|
| **Maximum** | ≤ 9007199254740991 |
|
|
526
526
|
|
|
527
527
|
----------------------------------------------------------------------------------------------------------------------------
|
|
528
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
528
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
529
529
|
|
|
530
530
|
:::warning Server-set
|
|
531
531
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -541,7 +541,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
541
541
|
**Description:** (Read-only) YYYY-MM-DD document ID repeated as a field. Identifies the day this snapshot covers.
|
|
542
542
|
|
|
543
543
|
----------------------------------------------------------------------------------------------------------------------------
|
|
544
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
544
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
545
545
|
|
|
546
546
|
:::warning Server-set
|
|
547
547
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -541,7 +541,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
541
541
|
**Description:** (Read-only) YYYY-MM document ID repeated as a field. Identifies the month this rollup covers.
|
|
542
542
|
|
|
543
543
|
----------------------------------------------------------------------------------------------------------------------------
|
|
544
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
544
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
545
545
|
|
|
546
546
|
:::warning Server-set
|
|
547
547
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -350,7 +350,7 @@ TBD/WIP — Originally from the archived Couchbase Lite (CBL) restaurant flow. C
|
|
|
350
350
|
| **Required** | No |
|
|
351
351
|
|
|
352
352
|
----------------------------------------------------------------------------------------------------------------------------
|
|
353
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
353
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
354
354
|
|
|
355
355
|
:::warning Server-set
|
|
356
356
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -1652,7 +1652,7 @@ Set only by the mobile app when the user manually edits the order total. Dashboa
|
|
|
1652
1652
|
**Description:** FK → Sale.id. Link to associated Sale document.
|
|
1653
1653
|
|
|
1654
1654
|
----------------------------------------------------------------------------------------------------------------------------
|
|
1655
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
1655
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
1656
1656
|
|
|
1657
1657
|
## Related Decisions
|
|
1658
1658
|
|
package/data/docs/models/sale.md
CHANGED
|
@@ -524,7 +524,7 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
524
524
|
| **Required** | No |
|
|
525
525
|
|
|
526
526
|
----------------------------------------------------------------------------------------------------------------------------
|
|
527
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
527
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
528
528
|
|
|
529
529
|
:::warning Server-set
|
|
530
530
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -197,4 +197,4 @@ Set at creation only. This field cannot be modified after the document is create
|
|
|
197
197
|
| **Maximum** | ≤ 9007199254740991 |
|
|
198
198
|
|
|
199
199
|
----------------------------------------------------------------------------------------------------------------------------
|
|
200
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
200
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
package/data/docs/models/site.md
CHANGED
|
@@ -546,7 +546,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
546
546
|
**Description:** Timestamp of the most recent analytics event seen for this site.
|
|
547
547
|
|
|
548
548
|
----------------------------------------------------------------------------------------------------------------------------
|
|
549
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
549
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
550
550
|
|
|
551
551
|
:::warning Server-set
|
|
552
552
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -497,4 +497,4 @@ Read-time hint snapshot of the verifier's display name (GH#29 §3 / Q10).
|
|
|
497
497
|
| **Required** | No |
|
|
498
498
|
|
|
499
499
|
----------------------------------------------------------------------------------------------------------------------------
|
|
500
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
500
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:17 +0000
|
|
@@ -642,7 +642,7 @@ Read-time hint snapshot of the completer's display name (GH#29 §3 / Q10).
|
|
|
642
642
|
| **Required** | No |
|
|
643
643
|
|
|
644
644
|
----------------------------------------------------------------------------------------------------------------------------
|
|
645
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
645
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:18 +0000
|
|
646
646
|
|
|
647
647
|
:::warning Server-set
|
|
648
648
|
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
@@ -388,7 +388,7 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
388
388
|
**Description:** (Immutable) FK → User/staff UID who created this ticket.
|
|
389
389
|
|
|
390
390
|
----------------------------------------------------------------------------------------------------------------------------
|
|
391
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
391
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:18 +0000
|
|
392
392
|
|
|
393
393
|
:::info Immutable
|
|
394
394
|
Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
|
|
@@ -366,4 +366,4 @@ Do not include in write requests. This field is set exclusively by the server (F
|
|
|
366
366
|
Specific value: `true`
|
|
367
367
|
|
|
368
368
|
----------------------------------------------------------------------------------------------------------------------------
|
|
369
|
-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-
|
|
369
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:18 +0000
|
|
@@ -0,0 +1,310 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "WhatsappOutboundLifecycleEvent"
|
|
3
|
+
sidebar_label: "WhatsappOutboundLifecycleEvent"
|
|
4
|
+
sidebar_position: 29
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# WhatsappOutboundLifecycleEvent
|
|
8
|
+
|
|
9
|
+
<details>
|
|
10
|
+
<summary>Example JSON</summary>
|
|
11
|
+
|
|
12
|
+
```json
|
|
13
|
+
{
|
|
14
|
+
"id": null,
|
|
15
|
+
"type": "phone",
|
|
16
|
+
"at": "at",
|
|
17
|
+
"status": "status",
|
|
18
|
+
"wamid": null,
|
|
19
|
+
"phoneNumberId": null,
|
|
20
|
+
"contactWaId": null,
|
|
21
|
+
"metaRequest": "metaRequest",
|
|
22
|
+
"metaResponse": "metaResponse",
|
|
23
|
+
"errorCode": null,
|
|
24
|
+
"errorDetail": "errorDetail"
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
</details>
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
- [1. Property `id`](#id)
|
|
32
|
+
- [2. Property `type`](#type)
|
|
33
|
+
- [2.1. Property `item 0`](#type_anyOf_i0)
|
|
34
|
+
- [2.2. Property `item 1`](#type_anyOf_i1)
|
|
35
|
+
- [3. Property `at`](#at)
|
|
36
|
+
- [3.1. Property `_seconds`](#at__seconds)
|
|
37
|
+
- [3.2. Property `_nanoseconds`](#at__nanoseconds)
|
|
38
|
+
- [4. Property `status`](#status)
|
|
39
|
+
- [4.1. Property `outbound-message-status`](#status_anyOf_i0)
|
|
40
|
+
- [4.2. Property `item 1`](#status_anyOf_i1)
|
|
41
|
+
- [5. Property `wamid`](#wamid)
|
|
42
|
+
- [6. Property `phoneNumberId`](#phoneNumberId)
|
|
43
|
+
- [7. Property `contactWaId`](#contactWaId)
|
|
44
|
+
- [8. Property `metaRequest`](#metaRequest)
|
|
45
|
+
- [9. Property `metaResponse`](#metaResponse)
|
|
46
|
+
- [10. Property `errorCode`](#errorCode)
|
|
47
|
+
- [11. Property `errorDetail`](#errorDetail)
|
|
48
|
+
|
|
49
|
+
| | |
|
|
50
|
+
| ------------------------- | ----------------------------------------------- |
|
|
51
|
+
| **Type** | `object` |
|
|
52
|
+
| **Required** | No |
|
|
53
|
+
| **Additional properties** | Not allowed |
|
|
54
|
+
| **Defined in** | #/definitions/whatsapp-outbound-lifecycle-event |
|
|
55
|
+
|
|
56
|
+
**Description:** ⚠️ BACKEND-INTERNAL — not a consumer contract. WhatsappOutboundLifecycleEvent: append-only backend log for reconstituting an outbound message lifecycle (GH#43). Collection: whatsapp_outbound_messages/\{messageId\}/lifecycle_events/\{eventId\}. Written/read only by the whatsapp-server backend.
|
|
57
|
+
|
|
58
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
59
|
+
| ---------------------------------- | ------- | --------------- | ---------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
60
|
+
| - [id](#id ) | No | string or null | No | - | (Read-only) Firestore document ID, auto-generated. |
|
|
61
|
+
| + [type](#type ) | No | Combination | No | - | (Read-only) Event type — send_attempt \| status_callback \| error \| future string. |
|
|
62
|
+
| + [at](#at ) | No | object | No | In #/definitions/firestore-timestamp | (Read-only) When the event was recorded server-side. |
|
|
63
|
+
| - [status](#status ) | No | Combination | No | - | (Read-only) Resulting/observed status, when this event implies one. |
|
|
64
|
+
| - [wamid](#wamid ) | No | string or null | No | - | (Read-only) WhatsApp message ID, if known at this point in the lifecycle. |
|
|
65
|
+
| - [phoneNumberId](#phoneNumberId ) | No | string or null | No | - | (Read-only) Meta phone number ID (the specific line within the WABA) used for the attempt. |
|
|
66
|
+
| - [contactWaId](#contactWaId ) | No | string or null | No | - | (Read-only) Normalized wa_id returned by Meta. May differ from the recipient \`to\`. |
|
|
67
|
+
| - [metaRequest](#metaRequest ) | No | object | No | - | (Read-only) Raw outbound payload sent to the Meta Graph API. |
|
|
68
|
+
| - [metaResponse](#metaResponse ) | No | object | No | - | (Read-only) Raw Meta Graph API response. |
|
|
69
|
+
| - [errorCode](#errorCode ) | No | integer or null | No | - | (Read-only) Meta error code. Present on failed attempts. |
|
|
70
|
+
| - [errorDetail](#errorDetail ) | No | object | No | - | (Read-only) Raw Meta error object(s). |
|
|
71
|
+
|
|
72
|
+
## <a name="id"></a>1. Property `id`
|
|
73
|
+
|
|
74
|
+
| | |
|
|
75
|
+
| ------------ | ---------------- |
|
|
76
|
+
| **Type** | `string or null` |
|
|
77
|
+
| **Required** | No |
|
|
78
|
+
|
|
79
|
+
**Description:** (Read-only) Firestore document ID, auto-generated.
|
|
80
|
+
|
|
81
|
+
:::warning Server-set
|
|
82
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
83
|
+
:::
|
|
84
|
+
|
|
85
|
+
## <a name="type"></a>2. Property `type`
|
|
86
|
+
|
|
87
|
+
| | |
|
|
88
|
+
| ------------------------- | ---------------- |
|
|
89
|
+
| **Type** | `combining` |
|
|
90
|
+
| **Required** | Yes |
|
|
91
|
+
| **Additional properties** | Any type allowed |
|
|
92
|
+
|
|
93
|
+
**Description:** (Read-only) Event type — send_attempt | status_callback | error | future string.
|
|
94
|
+
|
|
95
|
+
| Any of(Option) |
|
|
96
|
+
| ------------------------ |
|
|
97
|
+
| [item 0](#type_anyOf_i0) |
|
|
98
|
+
| [item 1](#type_anyOf_i1) |
|
|
99
|
+
|
|
100
|
+
### <a name="type_anyOf_i0"></a>2.1. Property `item 0`
|
|
101
|
+
|
|
102
|
+
| | |
|
|
103
|
+
| ------------ | ------------------ |
|
|
104
|
+
| **Type** | `enum (of string)` |
|
|
105
|
+
| **Required** | No |
|
|
106
|
+
|
|
107
|
+
Must be one of:
|
|
108
|
+
* "send_attempt"
|
|
109
|
+
* "status_callback"
|
|
110
|
+
* "error"
|
|
111
|
+
|
|
112
|
+
### <a name="type_anyOf_i1"></a>2.2. Property `item 1`
|
|
113
|
+
|
|
114
|
+
| | |
|
|
115
|
+
| ------------ | -------- |
|
|
116
|
+
| **Type** | `string` |
|
|
117
|
+
| **Required** | No |
|
|
118
|
+
|
|
119
|
+
:::warning Server-set
|
|
120
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
121
|
+
:::
|
|
122
|
+
|
|
123
|
+
## <a name="at"></a>3. Property `at`
|
|
124
|
+
|
|
125
|
+
| | |
|
|
126
|
+
| ------------------------- | --------------------------------- |
|
|
127
|
+
| **Type** | `object` |
|
|
128
|
+
| **Required** | Yes |
|
|
129
|
+
| **Additional properties** | Not allowed |
|
|
130
|
+
| **Defined in** | #/definitions/firestore-timestamp |
|
|
131
|
+
|
|
132
|
+
**Description:** (Read-only) When the event was recorded server-side.
|
|
133
|
+
|
|
134
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
135
|
+
| ----------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
|
|
136
|
+
| + [_seconds](#at__seconds ) | No | integer | No | - | - |
|
|
137
|
+
| + [_nanoseconds](#at__nanoseconds ) | No | integer | No | - | - |
|
|
138
|
+
|
|
139
|
+
### <a name="at__seconds"></a>3.1. Property `_seconds`
|
|
140
|
+
|
|
141
|
+
| | |
|
|
142
|
+
| ------------ | --------- |
|
|
143
|
+
| **Type** | `integer` |
|
|
144
|
+
| **Required** | Yes |
|
|
145
|
+
|
|
146
|
+
| Restrictions | |
|
|
147
|
+
| ------------ | ---------------------- |
|
|
148
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
149
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
150
|
+
|
|
151
|
+
### <a name="at__nanoseconds"></a>3.2. Property `_nanoseconds`
|
|
152
|
+
|
|
153
|
+
| | |
|
|
154
|
+
| ------------ | --------- |
|
|
155
|
+
| **Type** | `integer` |
|
|
156
|
+
| **Required** | Yes |
|
|
157
|
+
|
|
158
|
+
| Restrictions | |
|
|
159
|
+
| ------------ | ---------------------- |
|
|
160
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
161
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
162
|
+
|
|
163
|
+
:::warning Server-set
|
|
164
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
165
|
+
:::
|
|
166
|
+
|
|
167
|
+
## <a name="status"></a>4. Property `status`
|
|
168
|
+
|
|
169
|
+
| | |
|
|
170
|
+
| ------------------------- | ---------------- |
|
|
171
|
+
| **Type** | `combining` |
|
|
172
|
+
| **Required** | No |
|
|
173
|
+
| **Additional properties** | Any type allowed |
|
|
174
|
+
|
|
175
|
+
**Description:** (Read-only) Resulting/observed status, when this event implies one.
|
|
176
|
+
|
|
177
|
+
| Any of(Option) |
|
|
178
|
+
| ------------------------------------------- |
|
|
179
|
+
| [outbound-message-status](#status_anyOf_i0) |
|
|
180
|
+
| [item 1](#status_anyOf_i1) |
|
|
181
|
+
|
|
182
|
+
### <a name="status_anyOf_i0"></a>4.1. Property `outbound-message-status`
|
|
183
|
+
|
|
184
|
+
| | |
|
|
185
|
+
| -------------- | ------------------------------------- |
|
|
186
|
+
| **Type** | `enum (of string)` |
|
|
187
|
+
| **Required** | No |
|
|
188
|
+
| **Defined in** | #/definitions/outbound-message-status |
|
|
189
|
+
|
|
190
|
+
**Description:** Outbound WhatsApp message delivery status. Lifecycle: queued → sent → delivered → read, or queued → failed. The dashboard creates the message with status `queued`; the whatsapp-server backend owns every transition after, updating in place from Meta delivery callbacks (GH#43).
|
|
191
|
+
|
|
192
|
+
Must be one of:
|
|
193
|
+
* "queued"
|
|
194
|
+
* "sent"
|
|
195
|
+
* "delivered"
|
|
196
|
+
* "read"
|
|
197
|
+
* "failed"
|
|
198
|
+
|
|
199
|
+
### <a name="status_anyOf_i1"></a>4.2. Property `item 1`
|
|
200
|
+
|
|
201
|
+
| | |
|
|
202
|
+
| ------------ | ------ |
|
|
203
|
+
| **Type** | `null` |
|
|
204
|
+
| **Required** | No |
|
|
205
|
+
|
|
206
|
+
:::warning Server-set
|
|
207
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
208
|
+
:::
|
|
209
|
+
|
|
210
|
+
## <a name="wamid"></a>5. Property `wamid`
|
|
211
|
+
|
|
212
|
+
| | |
|
|
213
|
+
| ------------ | ---------------- |
|
|
214
|
+
| **Type** | `string or null` |
|
|
215
|
+
| **Required** | No |
|
|
216
|
+
|
|
217
|
+
**Description:** (Read-only) WhatsApp message ID, if known at this point in the lifecycle.
|
|
218
|
+
|
|
219
|
+
:::warning Server-set
|
|
220
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
221
|
+
:::
|
|
222
|
+
|
|
223
|
+
## <a name="phoneNumberId"></a>6. Property `phoneNumberId`
|
|
224
|
+
|
|
225
|
+
| | |
|
|
226
|
+
| ------------ | ---------------- |
|
|
227
|
+
| **Type** | `string or null` |
|
|
228
|
+
| **Required** | No |
|
|
229
|
+
|
|
230
|
+
**Description:** (Read-only) Meta phone number ID (the specific line within the WABA) used for the attempt.
|
|
231
|
+
|
|
232
|
+
:::warning Server-set
|
|
233
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
234
|
+
:::
|
|
235
|
+
|
|
236
|
+
## <a name="contactWaId"></a>7. Property `contactWaId`
|
|
237
|
+
|
|
238
|
+
| | |
|
|
239
|
+
| ------------ | ---------------- |
|
|
240
|
+
| **Type** | `string or null` |
|
|
241
|
+
| **Required** | No |
|
|
242
|
+
|
|
243
|
+
**Description:** (Read-only) Normalized wa_id returned by Meta. May differ from the recipient `to`.
|
|
244
|
+
|
|
245
|
+
:::warning Server-set
|
|
246
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
247
|
+
:::
|
|
248
|
+
|
|
249
|
+
## <a name="metaRequest"></a>8. Property `metaRequest`
|
|
250
|
+
|
|
251
|
+
| | |
|
|
252
|
+
| ------------------------- | ---------------- |
|
|
253
|
+
| **Type** | `object` |
|
|
254
|
+
| **Required** | No |
|
|
255
|
+
| **Additional properties** | Any type allowed |
|
|
256
|
+
|
|
257
|
+
**Description:** (Read-only) Raw outbound payload sent to the Meta Graph API.
|
|
258
|
+
|
|
259
|
+
:::warning Server-set
|
|
260
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
261
|
+
:::
|
|
262
|
+
|
|
263
|
+
## <a name="metaResponse"></a>9. Property `metaResponse`
|
|
264
|
+
|
|
265
|
+
| | |
|
|
266
|
+
| ------------------------- | ---------------- |
|
|
267
|
+
| **Type** | `object` |
|
|
268
|
+
| **Required** | No |
|
|
269
|
+
| **Additional properties** | Any type allowed |
|
|
270
|
+
|
|
271
|
+
**Description:** (Read-only) Raw Meta Graph API response.
|
|
272
|
+
|
|
273
|
+
:::warning Server-set
|
|
274
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
275
|
+
:::
|
|
276
|
+
|
|
277
|
+
## <a name="errorCode"></a>10. Property `errorCode`
|
|
278
|
+
|
|
279
|
+
| | |
|
|
280
|
+
| ------------ | ----------------- |
|
|
281
|
+
| **Type** | `integer or null` |
|
|
282
|
+
| **Required** | No |
|
|
283
|
+
|
|
284
|
+
**Description:** (Read-only) Meta error code. Present on failed attempts.
|
|
285
|
+
|
|
286
|
+
| Restrictions | |
|
|
287
|
+
| ------------ | ---------------------- |
|
|
288
|
+
| **Minimum** | ≥ -9007199254740991 |
|
|
289
|
+
| **Maximum** | ≤ 9007199254740991 |
|
|
290
|
+
|
|
291
|
+
:::warning Server-set
|
|
292
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
293
|
+
:::
|
|
294
|
+
|
|
295
|
+
## <a name="errorDetail"></a>11. Property `errorDetail`
|
|
296
|
+
|
|
297
|
+
| | |
|
|
298
|
+
| ------------------------- | ---------------- |
|
|
299
|
+
| **Type** | `object` |
|
|
300
|
+
| **Required** | No |
|
|
301
|
+
| **Additional properties** | Any type allowed |
|
|
302
|
+
|
|
303
|
+
**Description:** (Read-only) Raw Meta error object(s).
|
|
304
|
+
|
|
305
|
+
----------------------------------------------------------------------------------------------------------------------------
|
|
306
|
+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-27 at 01:15:18 +0000
|
|
307
|
+
|
|
308
|
+
:::warning Server-set
|
|
309
|
+
Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
|
|
310
|
+
:::
|