@convertrilo/sdk 0.0.6 → 0.0.8

package/dist/src/types.d.ts

@@ -564,7 +564,7 @@ export interface paths {
         };
         /**
          * List webhooks
-         * @description List managed webhook subscriptions for the authenticated user. Managed webhook deliveries include HMAC-SHA256 signatures.
+         * @description List managed webhook subscriptions for the authenticated user. API keys need the `webhooks:manage` scope. Managed webhook deliveries include HMAC-SHA256 signatures.
          */
         get: {
             parameters: {
@@ -591,6 +591,7 @@ export interface paths {
          * Create a webhook
          * @description Create a managed webhook subscription. The response includes `secret` exactly once.
          *     Store it securely and use it to verify `X-Webhook-Signature`.
+         *     API keys need the `webhooks:manage` scope.
          */
         post: {
             parameters: {
@@ -633,7 +634,7 @@ export interface paths {
         put?: never;
         /**
          * Test a webhook
-         * @description Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries.
+         * @description Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries. API keys need the `webhooks:manage` scope.
          */
         post: {
             parameters: {
@@ -655,7 +656,10 @@ export interface paths {
                 };
             };
         };
-        /** Delete a webhook */
+        /**
+         * Delete a webhook
+         * @description API keys need the `webhooks:manage` scope.
+         */
         delete: {
             parameters: {
                 query?: never;
@@ -678,7 +682,10 @@ export interface paths {
         };
         options?: never;
         head?: never;
-        /** Update a webhook */
+        /**
+         * Update a webhook
+         * @description API keys need the `webhooks:manage` scope.
+         */
         patch: {
             parameters: {
                 query?: never;
@@ -716,7 +723,7 @@ export interface paths {
         };
         /**
          * List webhook delivery attempts
-         * @description Returns the 50 most recent managed or test delivery attempts for this webhook.
+         * @description Returns the 50 most recent managed or test delivery attempts for this webhook. API keys need the `webhooks:manage` scope.
          */
         get: {
             parameters: {
@@ -1723,6 +1730,10 @@ export interface components {
             error?: string | null;
             attempt?: number;
             /** Format: date-time */
+            nextRetryAt?: string | null;
+            /** Format: date-time */
+            retriedAt?: string | null;
+            /** Format: date-time */
             createdAt?: string;
         };
         WebhookDeliveryListResponse: {

package/docs/WEBHOOKS.md

@@ -127,7 +127,28 @@ export async function POST(req: NextRequest) {
 - A webhook is automatically disabled after 10 consecutive failures
 - Re-enable it with `PATCH /webhooks/{id}` and `{ "isActive": true }`
 
-Current deliveries are best-effort. There is not yet a durable retry queue.
+Failed managed deliveries are scheduled for retry when possible.
+
+Retry schedule:
+
+- Attempt 2: about 1 minute after the failed attempt
+- Attempt 3: about 5 minutes after the failed attempt
+- Attempt 4: about 30 minutes after the failed attempt
+
+Run due retries with:
+
+```bash
+pnpm run webhooks:retry
+```
+
+Use `--limit` to cap one run:
+
+```bash
+pnpm run webhooks:retry -- --limit=50
+```
+
+Schedule this command every minute in production. Webhooks are still disabled after
+10 consecutive failures.
 
 ## Delivery History
 
@@ -153,6 +174,8 @@ The response includes the 50 most recent attempts for that webhook:
       "responseBody": null,
       "error": null,
       "attempt": 1,
+      "nextRetryAt": null,
+      "retriedAt": null,
       "createdAt": "2026-06-09T07:30:00.000Z"
     }
   ]

package/openapi.yaml

@@ -364,6 +364,8 @@ components:
           nullable: true
           description: Network, timeout, or delivery error, truncated to 2048 characters.
         attempt: { type: integer }
+        nextRetryAt: { type: string, format: date-time, nullable: true }
+        retriedAt: { type: string, format: date-time, nullable: true }
         createdAt: { type: string, format: date-time }
     WebhookDeliveryListResponse:
       type: object
@@ -837,9 +839,9 @@ paths:
 
   /webhooks:
     get:
-      security: [{ BearerAuth: [] }]
+      security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
       summary: List webhooks
-      description: List managed webhook subscriptions for the authenticated user. Managed webhook deliveries include HMAC-SHA256 signatures.
+      description: List managed webhook subscriptions for the authenticated user. API keys need the `webhooks:manage` scope. Managed webhook deliveries include HMAC-SHA256 signatures.
       responses:
         "200":
           description: List of webhooks
@@ -848,11 +850,12 @@ paths:
               schema:
                 $ref: "#/components/schemas/WebhookListResponse"
     post:
-      security: [{ BearerAuth: [] }]
+      security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
       summary: Create a webhook
       description: |
         Create a managed webhook subscription. The response includes `secret` exactly once.
         Store it securely and use it to verify `X-Webhook-Signature`.
+        API keys need the `webhooks:manage` scope.
       requestBody:
         required: true
         content:
@@ -874,8 +877,9 @@ paths:
                 $ref: "#/components/schemas/WebhookResponse"
   /webhooks/{id}:
     patch:
-      security: [{ BearerAuth: [] }]
+      security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
       summary: Update a webhook
+      description: API keys need the `webhooks:manage` scope.
       parameters:
         - in: path
           name: id
@@ -904,8 +908,9 @@ paths:
               schema:
                 $ref: "#/components/schemas/WebhookResponse"
     delete:
-      security: [{ BearerAuth: [] }]
+      security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
       summary: Delete a webhook
+      description: API keys need the `webhooks:manage` scope.
       parameters:
         - in: path
           name: id
@@ -914,9 +919,9 @@ paths:
       responses:
         "204": { description: Deleted }
     post:
-      security: [{ BearerAuth: [] }]
+      security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
       summary: Test a webhook
-      description: Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries.
+      description: Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries. API keys need the `webhooks:manage` scope.
       parameters:
         - in: path
           name: id
@@ -926,9 +931,9 @@ paths:
         "200": { description: Test event sent }
   /webhooks/{id}/deliveries:
     get:
-      security: [{ BearerAuth: [] }]
+      security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
       summary: List webhook delivery attempts
-      description: Returns the 50 most recent managed or test delivery attempts for this webhook.
+      description: Returns the 50 most recent managed or test delivery attempts for this webhook. API keys need the `webhooks:manage` scope.
       parameters:
         - in: path
           name: id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@convertrilo/sdk",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "TypeScript client for the Convertrilo video encoding API",
   "private": false,
   "license": "MIT",