Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(sdk): exclude the "*" wildcard from Python WebhookDelivery.event

Yudhi Armyndharise0db7e58c8f2
diff --git a/sdk/python/openwa/types.py b/sdk/python/openwa/types.py
index 92cfd8bab..420ea422f 100644
--- a/sdk/python/openwa/types.py
+++ b/sdk/python/openwa/types.py
@@ -73,6 +73,15 @@ WebhookEvent = Literal[
"call.accepted", "call.rejected", "call.missed",
"*",
]
+# The events a delivery can carry: WebhookEvent without the "*" subscription wildcard.
+WebhookDeliveryEvent = Literal[
+ "message.received", "message.sent", "message.ack", "message.failed", "message.revoked",
+ "message.reaction", "message.edited", "session.status", "session.qr", "session.authenticated",
+ "session.disconnected", "session.reconnect_loop", "session.restriction", "presence.update",
+ "group.join", "group.leave", "group.update", "group.join_request",
+ "call.received", "status.received",
+ "call.accepted", "call.rejected", "call.missed",
+]
class SetOwnPresenceRequest(TypedDict):
@@ -943,7 +952,7 @@ class WebhookDelivery(TypedDict):
:func:`openwa.verify_webhook_signature` before parsing it.
"""
- event: WebhookEvent | Literal["test"]
+ event: WebhookDeliveryEvent | Literal["test"]
timestamp: str
sessionId: str
idempotencyKey: str
diff --git a/sdk/python/tests/test_sdk.py b/sdk/python/tests/test_sdk.py
index 88e5e24f5..0ec7236af 100644
--- a/sdk/python/tests/test_sdk.py
+++ b/sdk/python/tests/test_sdk.py
@@ -4,6 +4,7 @@ from __future__ import annotations
import json
import time
+from typing import get_args
import httpx
import pytest
@@ -11,7 +12,7 @@ import pytest
from openwa import OpenWAClient, OpenWAApiError, OpenWANotFoundError
from openwa._http import build_url
from openwa.errors import OpenWAServiceUnavailableError
-from openwa.types import WebhookFilters
+from openwa.types import WebhookDelivery, WebhookDeliveryEvent, WebhookEvent, WebhookFilters
from conftest import MockBackend, make_client
@@ -654,6 +655,19 @@ class TestContacts:
class TestWebhooks:
+ def test_delivery_event_excludes_the_subscription_wildcard(self):
+ # "*" only matches a subscription; a delivery names one concrete event, or "test".
+ assert set(get_args(WebhookEvent)) == set(get_args(WebhookDeliveryEvent)) | {"*"}
+ delivery: WebhookDelivery = {
+ "event": "*", # type: ignore[typeddict-item]
+ "timestamp": "2026-02-02T10:00:00.000Z",
+ "sessionId": "s1",
+ "idempotencyKey": "k",
+ "deliveryId": "dlv_1",
+ "data": {},
+ }
+ assert delivery["event"] == "*"
+
def test_crud_test(self):
wh = {"id": "w1", "sessionId": "s", "url": "u", "events": ["*"], "active": True, "createdAt": "", "updatedAt": ""}
backend = MockBackend()