Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): say the * event wildcard skips message.receipt

Yudhi Armyndharis17ca97d35854
diff --git a/sdk/go/types_webhook.go b/sdk/go/types_webhook.go
index 648608e35..81c680864 100644
--- a/sdk/go/types_webhook.go
+++ b/sdk/go/types_webhook.go
@@ -5,7 +5,8 @@ import "encoding/json"
// WebhookEvent names an event a webhook may subscribe to. It is an alias for
// string so the Event* constants drop straight into the []string Events fields
// of CreateWebhookRequest / UpdateWebhookRequest without a conversion. Use
-// EventAll ("*") to receive every event.
+// EventAll ("*") to receive all events except EventMessageReceipt, which must
+// be named.
type WebhookEvent = string
// Events a webhook may subscribe to, mirroring the server's WEBHOOK_EVENTS
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/CreateWebhookRequest.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/CreateWebhookRequest.java
index d22863cfc..6cfdcc968 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/CreateWebhookRequest.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/CreateWebhookRequest.java
@@ -30,7 +30,10 @@ public record CreateWebhookRequest(
return this;
}
- /** Events to subscribe to. Use {@link WebhookEvent#ALL} to receive all. */
+ /**
+ * Events to subscribe to. Use {@link WebhookEvent#ALL} to receive all except
+ * {@link WebhookEvent#MESSAGE_RECEIPT}, which must be named.
+ */
public Builder events(List<WebhookEvent> v) {
this.events = v;
return this;
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/UpdateWebhookRequest.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/UpdateWebhookRequest.java
index e66fa37b0..1c14b0343 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/UpdateWebhookRequest.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/UpdateWebhookRequest.java
@@ -32,7 +32,10 @@ public record UpdateWebhookRequest(
return this;
}
- /** Events to subscribe to. Use {@link WebhookEvent#ALL} to receive all. */
+ /**
+ * Events to subscribe to. Use {@link WebhookEvent#ALL} to receive all except
+ * {@link WebhookEvent#MESSAGE_RECEIPT}, which must be named.
+ */
public Builder events(List<WebhookEvent> v) {
this.events = v;
return this;
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookEvent.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookEvent.java
index bd6134e3a..fd8a2a539 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookEvent.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookEvent.java
@@ -3,9 +3,9 @@ package com.rmyndharis.openwa.model;
import com.google.gson.annotations.SerializedName;
/**
- * Events a webhook may subscribe to. Use {@link #ALL} to receive all. The wire
- * values are dotted lowercase strings, so each constant carries a
- * {@link SerializedName} mapping.
+ * Events a webhook may subscribe to. Use {@link #ALL} to receive all except
+ * {@link #MESSAGE_RECEIPT}, which must be named. The wire values are dotted
+ * lowercase strings, so each constant carries a {@link SerializedName} mapping.
*/
public enum WebhookEvent {
@SerializedName("message.received")