Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): align SDK docs with the server on config and failures

Yudhi Armyndharis27479af00e13
diff --git a/docs/18-sdk-design.md b/docs/18-sdk-design.md
index 260c03471..9e00e3a97 100644
--- a/docs/18-sdk-design.md
+++ b/docs/18-sdk-design.md
@@ -132,7 +132,7 @@ The top-level client also exposes:
| -------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list` | `list(query?)` | List all sessions (scoped to the key's `allowedSessions`). The optional query takes `limit`, `offset` and `name` (an exact, case-sensitive match; no match returns an empty list). |
| `getConfig` | `getConfig(id)` | Read a session's engine configuration. |
-| `updateConfig` | `updateConfig(id, body)` | Update a running session's configuration; takes effect without re-linking the account. **OPERATOR** |
+| `updateConfig` | `updateConfig(id, body)` | Update a session's configuration, in any state, without a restart or re-link; `autoRejectCalls` applies immediately, the reconnect settings on the next start. **OPERATOR** |
| `getProxy` | `getProxy(id)` | Read a session's masked proxy configuration (credentials never returned). |
| `updateProxy` | `updateProxy(id, body)` | Update per-session proxy settings; changes apply on the next start, not to a running engine. Send `proxyUrl: null` to clear. **ADMIN** |
| `get` | `get(id)` | Get a single session by id. |
@@ -242,16 +242,16 @@ Media bodies share the `SendMediaRequest` shape: `{ chatId, url? | base64?, mime
#### `webhooks`
-| Method | Signature | Description |
-| ------------------ | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `listAll` | `listAll(query?)` | List webhooks across EVERY session the key can see, not one session's. **OPERATOR** |
-| `deliveryFailures` | `deliveryFailures(query?)` | Deliveries that were attempted and failed — the diagnostic for a webhook that stopped arriving. A delivery a smart filter suppressed never reaches this log. **ADMIN** |
-| `list` | `list(sessionId)` | List all webhooks for a session. **OPERATOR** |
-| `get` | `get(sessionId, id)` | Get a single webhook by id. **OPERATOR** |
-| `create` | `create(sessionId, body)` | Create a new webhook. **OPERATOR** |
-| `update` | `update(sessionId, id, body)` | Update a webhook. **OPERATOR** |
-| `delete` | `delete(sessionId, id)` | Delete a webhook. **OPERATOR** |
-| `test` | `test(sessionId, id)` | Trigger a test dispatch to the webhook URL and report the result. **OPERATOR** |
+| Method | Signature | Description |
+| ------------------ | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `listAll` | `listAll(query?)` | List webhooks across EVERY session the key can see, not one session's. **OPERATOR** |
+| `deliveryFailures` | `deliveryFailures(query?)` | Deliveries that exhausted their retries (`attempts > 0`), or were shed, oversize, failed preflight or refused at shutdown, possibly between retries (`attempts: 0`); a later successful delivery removes the row — the diagnostic for a webhook that stopped arriving. A delivery a smart filter suppressed never reaches this log. **ADMIN** |
+| `list` | `list(sessionId)` | List all webhooks for a session. **OPERATOR** |
+| `get` | `get(sessionId, id)` | Get a single webhook by id. **OPERATOR** |
+| `create` | `create(sessionId, body)` | Create a new webhook. **OPERATOR** |
+| `update` | `update(sessionId, id, body)` | Update a webhook. **OPERATOR** |
+| `delete` | `delete(sessionId, id)` | Delete a webhook. **OPERATOR** |
+| `test` | `test(sessionId, id)` | Trigger a test dispatch to the webhook URL and report the result. **OPERATOR** |
#### `labels` _(WhatsApp Business)_
@@ -508,7 +508,7 @@ Resources are accessed as properties on the client (e.g. `client.messages`). All
| ---------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list` | `list(query=None) -> list[SessionResponse]` | List all sessions. The optional query takes `limit`, `offset` and `name` (an exact, case-sensitive match; no match returns an empty list). |
| `get_config` | `get_config(session_id) -> SessionConfig` | Read a session's engine configuration. |
-| `update_config` | `update_config(session_id, body) -> SessionConfig` | Update a running session's configuration; takes effect without re-linking the account. **OPERATOR** |
+| `update_config` | `update_config(session_id, body) -> SessionConfig` | Update a session's configuration, in any state, without a restart or re-link; `autoRejectCalls` applies immediately, the reconnect settings on the next start. **OPERATOR** |
| `get_proxy` | `get_proxy(session_id) -> SessionProxy` | Read a session's masked proxy configuration (credentials never returned). |
| `update_proxy` | `update_proxy(session_id, body) -> SessionProxy` | Update per-session proxy settings; changes apply on the next start. Send `proxyUrl: null` to clear. **ADMIN** |
| `get` | `get(session_id) -> SessionResponse` | Get one session. |
@@ -616,16 +616,16 @@ Resources are accessed as properties on the client (e.g. `client.messages`). All
#### `client.webhooks`
-| Method | Signature | Description |
-| ------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `list_all` | `list_all(query=None) -> list[WebhookResponse]` | List webhooks across EVERY session the key can see, not one session's. **OPERATOR** |
-| `delivery_failures` | `delivery_failures(query=None) -> list[WebhookDeliveryFailure]` | Deliveries that were attempted and failed — the diagnostic for a webhook that stopped arriving. A delivery a smart filter suppressed never reaches this log. **ADMIN** |
-| `list` | `list(session_id) -> list[WebhookResponse]` | List webhooks. **OPERATOR** |
-| `get` | `get(session_id, webhook_id) -> WebhookResponse` | Get one webhook. **OPERATOR** |
-| `create` | `create(session_id, body) -> WebhookResponse` | Create a webhook. **OPERATOR** |
-| `update` | `update(session_id, webhook_id, body) -> WebhookResponse` | Update a webhook. **OPERATOR** |
-| `delete` | `delete(session_id, webhook_id) -> None` | Delete a webhook. **OPERATOR** |
-| `test` | `test(session_id, webhook_id) -> WebhookTestResult` | Send a test delivery. **OPERATOR** |
+| Method | Signature | Description |
+| ------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `list_all` | `list_all(query=None) -> list[WebhookResponse]` | List webhooks across EVERY session the key can see, not one session's. **OPERATOR** |
+| `delivery_failures` | `delivery_failures(query=None) -> list[WebhookDeliveryFailure]` | Deliveries that exhausted their retries (`attempts > 0`), or were shed, oversize, failed preflight or refused at shutdown, possibly between retries (`attempts: 0`); a later successful delivery removes the row — the diagnostic for a webhook that stopped arriving. A delivery a smart filter suppressed never reaches this log. **ADMIN** |
+| `list` | `list(session_id) -> list[WebhookResponse]` | List webhooks. **OPERATOR** |
+| `get` | `get(session_id, webhook_id) -> WebhookResponse` | Get one webhook. **OPERATOR** |
+| `create` | `create(session_id, body) -> WebhookResponse` | Create a webhook. **OPERATOR** |
+| `update` | `update(session_id, webhook_id, body) -> WebhookResponse` | Update a webhook. **OPERATOR** |
+| `delete` | `delete(session_id, webhook_id) -> None` | Delete a webhook. **OPERATOR** |
+| `test` | `test(session_id, webhook_id) -> WebhookTestResult` | Send a test delivery. **OPERATOR** |
#### `client.labels` _(WhatsApp Business)_
@@ -858,7 +858,7 @@ All payloads are associative arrays; all listed methods are synchronous and retu
| -------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list` | `list(array $query = []): array` | List all sessions. The optional query takes `limit`, `offset` and `name` (an exact, case-sensitive match; no match returns an empty list). |
| `getConfig` | `getConfig(string $id): array` | Read a session's engine configuration. |
-| `updateConfig` | `updateConfig(string $id, array $body): array` | Update a running session's configuration; takes effect without re-linking the account. **OPERATOR** |
+| `updateConfig` | `updateConfig(string $id, array $body): array` | Update a session's configuration, in any state, without a restart or re-link; `autoRejectCalls` applies immediately, the reconnect settings on the next start. **OPERATOR** |
| `getProxy` | `getProxy(string $id): array` | Read a session's masked proxy configuration (credentials never returned). |
| `updateProxy` | `updateProxy(string $id, array $body): array` | Update per-session proxy settings; changes apply on the next start. Send `proxyUrl: null` to clear. **ADMIN** |
| `get` | `get(string $id): array` | Get one session. |
@@ -966,16 +966,16 @@ All payloads are associative arrays; all listed methods are synchronous and retu
#### `webhooks`
-| Method | Signature | Description |
-| ------------------ | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `listAll` | `listAll(array $query = []): array` | List webhooks across EVERY session the key can see, not one session's. **OPERATOR** |
-| `deliveryFailures` | `deliveryFailures(array $query = [])` | Deliveries that were attempted and failed — the diagnostic for a webhook that stopped arriving. A delivery a smart filter suppressed never reaches this log. **ADMIN** |
-| `list` | `list(string $sessionId): array` | List webhooks. **OPERATOR** |
-| `get` | `get(string $sessionId, string $id): array` | Get one webhook. **OPERATOR** |
-| `create` | `create(string $sessionId, array $body): array` | Create a webhook. **OPERATOR** |
-| `update` | `update(string $sessionId, string $id, array $body): array` | Update a webhook. **OPERATOR** |
-| `delete` | `delete(string $sessionId, string $id): void` | Delete a webhook. **OPERATOR** |
-| `test` | `test(string $sessionId, string $id): array` | Send a test event. **OPERATOR** |
+| Method | Signature | Description |
+| ------------------ | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `listAll` | `listAll(array $query = []): array` | List webhooks across EVERY session the key can see, not one session's. **OPERATOR** |
+| `deliveryFailures` | `deliveryFailures(array $query = [])` | Deliveries that exhausted their retries (`attempts > 0`), or were shed, oversize, failed preflight or refused at shutdown, possibly between retries (`attempts: 0`); a later successful delivery removes the row — the diagnostic for a webhook that stopped arriving. A delivery a smart filter suppressed never reaches this log. **ADMIN** |
+| `list` | `list(string $sessionId): array` | List webhooks. **OPERATOR** |
+| `get` | `get(string $sessionId, string $id): array` | Get one webhook. **OPERATOR** |
+| `create` | `create(string $sessionId, array $body): array` | Create a webhook. **OPERATOR** |
+| `update` | `update(string $sessionId, string $id, array $body): array` | Update a webhook. **OPERATOR** |
+| `delete` | `delete(string $sessionId, string $id): void` | Delete a webhook. **OPERATOR** |
+| `test` | `test(string $sessionId, string $id): array` | Send a test event. **OPERATOR** |
#### `labels` _(WhatsApp Business)_
diff --git a/docs/21-glossary.md b/docs/21-glossary.md
index fdcfc129d..ef9e65ae5 100644
--- a/docs/21-glossary.md
+++ b/docs/21-glossary.md
@@ -73,7 +73,7 @@ Web interface to manage OpenWA without using the API directly. Built with React
### Dead Letter Queue (DLQ)
-The durable record of deliveries abandoned after every retry. In OpenWA it is a **database table**, not a Redis queue: `webhook_delivery_failures` for outbound webhooks and `integration_delivery_failures` for plugin ingress. Used for debugging; **redrive exists for plugin ingress only** (`POST /api/integration/instances/:pluginId/:instanceId/redrive`); an outbound-webhook failure row is a record, not a replay source, so recovery means the provider or your own tooling re-sending the event.
+The durable record of deliveries abandoned after every retry; an outbound-webhook row with `attempts: 0` was instead shed, oversize, failed preflight or refused at shutdown, and a later successful delivery of the event removes its row. In OpenWA it is a **database table**, not a Redis queue: `webhook_delivery_failures` for outbound webhooks and `integration_delivery_failures` for plugin ingress. Used for debugging; **redrive exists for plugin ingress only** (`POST /api/integration/instances/:pluginId/:instanceId/redrive`); an outbound-webhook failure row is a record, not a replay source. The gateway replays a shed or shutdown-refused delivery from its outbox on its own; any other recovery means the provider or your own tooling re-sending the event.
### Docker
diff --git a/sdk/go/types_webhook.go b/sdk/go/types_webhook.go
index 5c1195c6d..2a0ebcafc 100644
--- a/sdk/go/types_webhook.go
+++ b/sdk/go/types_webhook.go
@@ -180,9 +180,9 @@ type WebhookTestResult struct {
Error string `json:"error,omitempty"`
}
-// WebhookDeliveryFailure is a webhook delivery that exhausted its retries, or
-// one never sent (Attempts 0) that the outbox replays, as listed by the
-// delivery-failure log. A later successful delivery removes the row.
+// WebhookDeliveryFailure is a webhook delivery the gateway gave up on or could
+// not dispatch, as listed by the delivery-failure log. A later successful
+// delivery removes the row.
type WebhookDeliveryFailure struct {
ID string `json:"id"`
WebhookID string `json:"webhookId"`
diff --git a/sdk/go/webhooks.go b/sdk/go/webhooks.go
index d9aa89e74..3b923d83b 100644
--- a/sdk/go/webhooks.go
+++ b/sdk/go/webhooks.go
@@ -20,9 +20,10 @@ func (s *WebhooksService) ListAll(ctx context.Context, query *DeliveryFailureQue
// DeliveryFailures returns deliveries the gateway gave up on or could not dispatch: the diagnostic
// for a webhook that stopped arriving. Rows with Attempts > 0 exhausted their retries against the
-// receiver; rows with Attempts == 0 were never sent (payload over the size cap, a webhook:before hook
-// error, dispatch capacity shed, or shutdown). A row is removed once a later replay delivers the
-// event. Requires an ADMIN-level key.
+// receiver. Rows with Attempts == 0 were not given up after retries: the payload was over the size
+// cap or could not be serialized after the webhook:before hooks, dispatch capacity was shed, or
+// shutdown interrupted the delivery (possibly between retries, after earlier attempts were sent). A
+// row is removed once a later replay delivers the event. Requires an ADMIN-level key.
//
// A delivery a smart filter suppressed never reaches this log. Most recent first.
func (s *WebhooksService) DeliveryFailures(ctx context.Context, query *DeliveryFailureQuery) ([]WebhookDeliveryFailure, error) {
diff --git a/sdk/java/README.md b/sdk/java/README.md
index 8510cb029..e7488aad1 100644
--- a/sdk/java/README.md
+++ b/sdk/java/README.md
@@ -30,9 +30,9 @@ implementation 'com.rmyndharis:openwa:0.5.0'
This README describes `main`. The 0.5.0 release lacks `sessions.getProxy`,
`sessions.updateProxy`, `messages.clickButton`, the `name` filter of
`ListSessionsQuery`, `WebhookSignature.verify`, the `WebhookDelivery` types, the
-`code()`, `retryAfterSeconds()` and `headers()` error accessors and the
-`UNKNOWN` enum fallback; they ship with the next SDK release. See [the SDK
-overview](../README.md#coverage).
+`code()`, `retryAfterSeconds()` and `headers()` error accessors, the `UNKNOWN`
+enum fallback and the refusal of an empty, `.` or `..` id or path segment; they
+ship with the next SDK release. See [the SDK overview](../README.md#coverage).
## Quickstart
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java
index eeb8adad6..27ffc505a 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java
@@ -15,9 +15,9 @@ public record WebhookDeliveryFailure(
String deliveryId,
/**
* Delivery attempts recorded; 0 when the delivery was shed, refused or failed before sending
- * (oversize payload, webhook:before hook error, capacity shed or shutdown). A direct delivery
- * that shutdown caught in a retry backoff also records 0, although its earlier attempts were
- * sent.
+ * (oversize payload, a payload that could not be serialized after the webhook:before hooks,
+ * capacity shed or shutdown). A direct delivery that shutdown caught in a retry backoff also
+ * records 0, although its earlier attempts were sent.
*/
int attempts,
/**
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/WebhooksResource.java b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/WebhooksResource.java
index 992304da1..295d40d93 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/WebhooksResource.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/WebhooksResource.java
@@ -30,10 +30,11 @@ public final class WebhooksResource {
/**
* Deliveries the gateway gave up on or could not dispatch: the diagnostic for a webhook that
- * stopped arriving. Rows with {@code attempts > 0} exhausted their retries against the receiver;
- * rows with {@code attempts == 0} were never sent (payload over the size cap, a webhook:before
- * hook error, dispatch capacity shed, or shutdown). A row is removed once a later replay delivers
- * the event. Requires an ADMIN-level key.
+ * stopped arriving. Rows with {@code attempts > 0} exhausted their retries against the receiver.
+ * Rows with {@code attempts == 0} were not given up after retries: the payload was over the size
+ * cap or could not be serialized after the webhook:before hooks, dispatch capacity was shed, or
+ * shutdown interrupted the delivery (possibly between retries, after earlier attempts were sent).
+ * A row is removed once a later replay delivers the event. Requires an ADMIN-level key.
*
* <p>A delivery a smart filter suppressed never reaches this log. Most recent first.
*/
diff --git a/sdk/javascript/README.md b/sdk/javascript/README.md
index c47b5d351..7adf63089 100644
--- a/sdk/javascript/README.md
+++ b/sdk/javascript/README.md
@@ -14,9 +14,10 @@ Requires Node.js >= 18 (relies on the global `fetch`).
This README describes `main`. The 0.5.0 release lacks `sessions.getProxy`,
`sessions.updateProxy`, `messages.clickButton`, the `name` filter on
-`sessions.list`, `verifyWebhookSignature`, the `WebhookDelivery` types and the
-`code`, `retryAfterSeconds` and `headers` error fields; they ship with the next
-SDK release. See [the SDK overview](../README.md#coverage).
+`sessions.list`, `verifyWebhookSignature`, the `WebhookDelivery` types, the
+`code`, `retryAfterSeconds` and `headers` error fields and the refusal of an
+empty, `.` or `..` id or path segment; they ship with the next SDK release. See
+[the SDK overview](../README.md#coverage).
## Usage
diff --git a/sdk/javascript/src/resources/sessions.ts b/sdk/javascript/src/resources/sessions.ts
index e0f218c8f..8d3479c9d 100644
--- a/sdk/javascript/src/resources/sessions.ts
+++ b/sdk/javascript/src/resources/sessions.ts
@@ -47,8 +47,9 @@ export class SessionsResource {
}
/**
- * Update a running session's configuration. Takes effect without re-linking the account — all three
- * fields were fixed at creation before this route existed.
+ * Update a session's configuration, in any state, without a restart or re-linking the account (all
+ * three fields were fixed at creation before this route existed). `autoRejectCalls` applies
+ * immediately; `maxReconnectAttempts` and `reconnectBaseDelay` apply on the next start.
*/
updateConfig(id: string, body: UpdateSessionConfigRequest): Promise<SessionConfig> {
return this.client.request<SessionConfig>({
diff --git a/sdk/javascript/src/types.ts b/sdk/javascript/src/types.ts
index 7c1720c28..585c3f6b8 100644
--- a/sdk/javascript/src/types.ts
+++ b/sdk/javascript/src/types.ts
@@ -65,7 +65,11 @@ export interface SessionResponse {
lastActive?: string | null;
createdAt: string;
updatedAt: string;
- /** Only present when `status === 'failed'` (terminal failure) or `status === 'action_required'` (operator must intervene). */
+ /**
+ * Human-readable reason while `status` is `'failed'` or `'action_required'`, or `'initializing'` during
+ * a prolonged automatic reconnect (fifth attempt onward, or while a failed relaunch waits to retry);
+ * `null` otherwise.
+ */
lastError?: string | null;
/**
* A limit WhatsApp itself has placed on the account, or `null` when there is none. Distinct from
diff --git a/sdk/php/README.md b/sdk/php/README.md
index c5fb481e9..6f955fb97 100644
--- a/sdk/php/README.md
+++ b/sdk/php/README.md
@@ -13,9 +13,10 @@ composer require rmyndharis/openwa
Requires PHP 8.1+ and Guzzle 7. The namespace is `OpenWA\`.
This README describes `main`. The 0.5.0 release lacks `sessions->getProxy`,
-`sessions->updateProxy`, `messages->clickButton`, `WebhookSignature::verify` and the
-`getErrorCode()`, `getRetryAfterSeconds()` and `getHeaders()` exception methods; they ship with the
-next SDK release. See [the SDK overview](../README.md#coverage).
+`sessions->updateProxy`, `messages->clickButton`, `WebhookSignature::verify`, the
+`getErrorCode()`, `getRetryAfterSeconds()` and `getHeaders()` exception methods, the refusal of an
+empty, `.` or `..` id and the `sessions->create()` fix that sends an empty `config` as `{}`; they
+ship with the next SDK release. See [the SDK overview](../README.md#coverage).
## Usage
diff --git a/sdk/python/README.md b/sdk/python/README.md
index bc1fdab76..8bcc2b04e 100644
--- a/sdk/python/README.md
+++ b/sdk/python/README.md
@@ -14,9 +14,9 @@ Requires Python 3.9+. The importable module is `openwa`.
This README describes `main`. The 0.5.0 release lacks `sessions.get_proxy`,
`sessions.update_proxy`, `messages.click_button`, `verify_webhook_signature`, the `WebhookDelivery`
-type, the `.code`, `.retry_after_seconds` and `.headers` error attributes and the `name` key of
-`ListSessionsQuery`; they ship with the next SDK release. See
-[the SDK overview](../README.md#coverage).
+type, the `.code`, `.retry_after_seconds` and `.headers` error attributes, the `name` key of
+`ListSessionsQuery` and the refusal of an empty, `.` or `..` id; they ship with the next SDK
+release. See [the SDK overview](../README.md#coverage).
## Usage
diff --git a/sdk/python/openwa/resources/webhooks.py b/sdk/python/openwa/resources/webhooks.py
index 09240ebd4..7a0accf67 100644
--- a/sdk/python/openwa/resources/webhooks.py
+++ b/sdk/python/openwa/resources/webhooks.py
@@ -45,11 +45,12 @@ class WebhooksResource:
return self._http.request("GET", "/api/webhooks", query=query)
def delivery_failures(self, query: DeliveryFailureQuery | None = None) -> list[WebhookDeliveryFailure]:
- """Deliveries the gateway gave up on or could not send -- the diagnostic for a webhook that stopped arriving.
+ """Deliveries the gateway gave up on or could not dispatch: the diagnostic for a webhook that stopped arriving.
- Rows with ``attempts > 0`` exhausted their retries against the receiver; rows with ``attempts == 0``
- were never sent (payload over the size cap, a payload that could not be prepared or serialized,
- dispatch capacity shed, or shutdown). A row is removed once a later replay delivers the event.
+ Rows with ``attempts > 0`` exhausted their retries against the receiver. Rows with ``attempts == 0``
+ were not given up after retries: the payload was over the size cap or could not be prepared or
+ serialized, dispatch capacity was shed, or shutdown interrupted the delivery (possibly between
+ retries, after earlier attempts were sent). A row is removed once a later replay delivers the event.
Requires an ADMIN-level key. A delivery a smart filter suppressed never reaches this log. Most
recent first.
diff --git a/sdk/python/openwa/types.py b/sdk/python/openwa/types.py
index da1fa33fd..524eb88d4 100644
--- a/sdk/python/openwa/types.py
+++ b/sdk/python/openwa/types.py
@@ -953,7 +953,7 @@ class WebhookDelivery(TypedDict):
class WebhookDeliveryFailure(TypedDict):
- """A webhook delivery that exhausted its retries or was never sent, as listed by the delivery-failure log."""
+ """A webhook delivery the gateway gave up on or could not dispatch, as listed by the delivery-failure log."""
id: str
webhookId: str