@sentdm/sentdm 0.34.0 → 0.36.0

package/src/resources/webhooks.ts

@@ -8,7 +8,11 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 /**
- * Configure webhook endpoints for real-time event delivery
+ * Delivery reports and inbound messages, pushed to you.
+ *
+ * Subscribe an endpoint to the event types you care about — `GET /v3/webhooks/event-types` lists them — and we POST each one as it happens, retrying on failure. Polling `GET /v3/messages/{id}` works and does not scale.
+ *
+ * **Verify the signature.** Every delivery is signed with your endpoint's secret; an unverified endpoint is one anybody can post to. `rotate-secret` replaces it, `test` sends a specimen event, and `GET /v3/webhooks/{id}/events` shows what we tried to deliver and what your endpoint answered — which is the first place to look when something appears to be missing.
  */
 export class Webhooks extends APIResource {
   /**
@@ -16,10 +20,10 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseWebhook = await client.webhooks.create();
+   * const webhook = await client.webhooks.create();
    * ```
    */
-  create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<APIResponseWebhook> {
+  create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.post('/v3/webhooks', {
       body,
@@ -39,7 +43,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseWebhook = await client.webhooks.retrieve(
+   * const webhook = await client.webhooks.retrieve(
    *   'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
    * );
    * ```
@@ -48,7 +52,7 @@ export class Webhooks extends APIResource {
     id: string,
     params: WebhookRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<APIResponseWebhook> {
+  ): APIPromise<WebhookRetrieveResponse> {
     const { 'x-profile-id': xProfileID } = params ?? {};
     return this._client.get(path`/v3/webhooks/${id}`, {
       ...options,
@@ -64,12 +68,16 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseWebhook = await client.webhooks.update(
+   * const webhook = await client.webhooks.update(
    *   'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
    * );
    * ```
    */
-  update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<APIResponseWebhook> {
+  update(
+    id: string,
+    params: WebhookUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<WebhookUpdateResponse> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.put(path`/v3/webhooks/${id}`, {
       body,
@@ -241,17 +249,16 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseWebhook =
-   *   await client.webhooks.toggleStatus(
-   *     'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
-   *   );
+   * const response = await client.webhooks.toggleStatus(
+   *   'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
+   * );
    * ```
    */
   toggleStatus(
     id: string,
     params: WebhookToggleStatusParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseWebhook> {
+  ): APIPromise<WebhookToggleStatusResponse> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.patch(path`/v3/webhooks/${id}/toggle-status`, {
       body,
@@ -267,76 +274,6 @@ export class Webhooks extends APIResource {
   }
 }
 
-/**
- * Request and response metadata
- */
-export interface APIMeta {
-  /**
-   * Unique identifier for this request (for tracing and support)
-   */
-  request_id?: string;
-
-  /**
-   * Server timestamp when the response was generated
-   */
-  timestamp?: string;
-
-  /**
-   * API version used for this request
-   */
-  version?: string;
-}
-
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface APIResponseWebhook {
-  /**
-   * The response data (null if error)
-   */
-  data?: WebhookResponse | null;
-
-  /**
-   * Error information
-   */
-  error?: ErrorDetail | null;
-
-  /**
-   * Request and response metadata
-   */
-  meta?: APIMeta;
-
-  /**
-   * Indicates whether the request was successful
-   */
-  success?: boolean;
-}
-
-/**
- * Error information
- */
-export interface ErrorDetail {
-  /**
-   * Machine-readable error code (e.g., "RESOURCE_001")
-   */
-  code?: string;
-
-  /**
-   * Additional validation error details (field-level errors)
-   */
-  details?: { [key: string]: Array<string> } | null;
-
-  /**
-   * URL to documentation about this error
-   */
-  doc_url?: string | null;
-
-  /**
-   * Human-readable error message
-   */
-  message?: string;
-}
-
 /**
  * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
  * this shape and varies only in Payload.
@@ -374,6 +311,16 @@ export interface InboundMessageEvent {
  * numbers.
  */
 export interface InboundMessageEventPayload {
+  /**
+   * The contact's number in E.164 format, meaning the number the message came from.
+   */
+  inbound_number: string;
+
+  /**
+   * When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+   */
+  received_at: string;
+
   /**
    * The account the message belongs to.
    */
@@ -384,11 +331,6 @@ export interface InboundMessageEventPayload {
    */
   channel?: string;
 
-  /**
-   * The contact's number in E.164 format, meaning the number the message came from.
-   */
-  inbound_number?: string;
-
   /**
    * The inbound message.
    */
@@ -399,11 +341,6 @@ export interface InboundMessageEventPayload {
    */
   outbound_number?: string;
 
-  /**
-   * When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
-   */
-  received_at?: string;
-
   /**
    * The message body. Sent as null when the inbound message carried no text, for
    * example a media-only message. The field is always present, so read it and check
@@ -457,6 +394,13 @@ export interface MessageEvent {
  * status.
  */
 export interface MessageEventPayload {
+  /**
+   * The status the message just reached, for example SENT, DELIVERED, or FAILED.
+   * Sent means dispatched and delivered means confirmed, so treat them as distinct
+   * outcomes.
+   */
+  message_status: string;
+
   /**
    * The account the message belongs to.
    */
@@ -479,13 +423,6 @@ export interface MessageEventPayload {
    */
   message_id?: string;
 
-  /**
-   * The status the message just reached, for example SENT, DELIVERED, or FAILED.
-   * Sent means dispatched and delivered means confirmed, so treat them as distinct
-   * outcomes.
-   */
-  message_status?: string;
-
   /**
    * The recipient's number in E.164 format.
    */
@@ -508,66 +445,6 @@ export interface MessageEventPayload {
   updated_at?: string;
 }
 
-export interface MutationRequest {
-  /**
-   * Sandbox flag - when true, the operation is simulated without side effects Useful
-   * for testing integrations without actual execution
-   */
-  sandbox?: boolean;
-}
-
-/**
- * Pagination metadata for list responses
- */
-export interface PaginationMeta {
-  /**
-   * Cursor-based pagination pointers
-   */
-  cursors?: PaginationMeta.Cursors | null;
-
-  /**
-   * Whether there are more pages after this one
-   */
-  has_more?: boolean;
-
-  /**
-   * Current page number (1-indexed)
-   */
-  page?: number;
-
-  /**
-   * Number of items per page
-   */
-  page_size?: number;
-
-  /**
-   * Total number of items across all pages
-   */
-  total_count?: number;
-
-  /**
-   * Total number of pages
-   */
-  total_pages?: number;
-}
-
-export namespace PaginationMeta {
-  /**
-   * Cursor-based pagination pointers
-   */
-  export interface Cursors {
-    /**
-     * Cursor to fetch the next page
-     */
-    after?: string | null;
-
-    /**
-     * Cursor to fetch the previous page
-     */
-    before?: string | null;
-  }
-}
-
 /**
  * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
  * this shape and varies only in Payload.
@@ -605,6 +482,17 @@ export interface TemplateEvent {
  * changes, so you can react without polling.
  */
 export interface TemplateEventPayload {
+  /**
+   * The review status the template just reached, for example APPROVED or REJECTED.
+   */
+  status: string;
+
+  /**
+   * The template's identifier with Meta, assigned when the template is submitted for
+   * review.
+   */
+  whatsapp_template_id: string;
+
   /**
    * The account the template belongs to.
    */
@@ -631,11 +519,6 @@ export interface TemplateEventPayload {
    */
   reason?: string | null;
 
-  /**
-   * The review status the template just reached, for example APPROVED or REJECTED.
-   */
-  status?: string;
-
   /**
    * The template in Sent.
    */
@@ -645,76 +528,137 @@ export interface TemplateEventPayload {
    * The template's display name.
    */
   template_name?: string;
+}
 
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface WebhookCreateResponse {
   /**
-   * The template's identifier with Meta, assigned when the template is submitted for
-   * review.
+   * The response data (null if error)
+   */
+  data?: WebhookCreateResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhookCreateResponse.Error | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhookCreateResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
    */
-  whatsapp_template_id?: string;
+  success?: boolean;
 }
 
-export interface WebhookEventType {
-  description?: string | null;
+export namespace WebhookCreateResponse {
+  /**
+   * The response data (null if error)
+   */
+  export interface Data {
+    id?: string;
 
-  display_name?: string;
+    consecutive_failures?: number;
 
-  event_type?: string | null;
+    created_at?: string;
 
-  is_active?: boolean;
+    /**
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
+     */
+    customer_id?: string;
 
-  name?: string;
+    display_name?: string;
 
-  sub_types?: Array<WebhookEventType> | null;
-}
+    endpoint_url?: string;
 
-export interface WebhookResponse {
-  id?: string;
+    event_filters?: { [key: string]: Array<string> } | null;
 
-  consecutive_failures?: number;
+    event_types?: Array<string>;
 
-  created_at?: string;
+    is_active?: boolean;
 
-  display_name?: string;
+    last_delivery_attempt_at?: string | null;
 
-  endpoint_url?: string;
+    last_successful_delivery_at?: string | null;
 
-  event_filters?: { [key: string]: Array<string> } | null;
+    retry_count?: number;
 
-  event_types?: Array<string>;
+    signing_secret?: string | null;
 
-  is_active?: boolean;
+    timeout_seconds?: number;
 
-  last_delivery_attempt_at?: string | null;
+    updated_at?: string | null;
+  }
 
-  last_successful_delivery_at?: string | null;
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
 
-  retry_count?: number;
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
 
-  signing_secret?: string | null;
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
 
-  timeout_seconds?: number;
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
 
-  updated_at?: string | null;
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
 }
 
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface WebhookListResponse {
+export interface WebhookRetrieveResponse {
   /**
    * The response data (null if error)
    */
-  data?: WebhookListResponse.Data | null;
+  data?: WebhookRetrieveResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: ErrorDetail | null;
+  error?: WebhookRetrieveResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: APIMeta;
+  meta?: WebhookRetrieveResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -722,72 +666,110 @@ export interface WebhookListResponse {
   success?: boolean;
 }
 
-export namespace WebhookListResponse {
+export namespace WebhookRetrieveResponse {
   /**
    * The response data (null if error)
    */
   export interface Data {
+    id?: string;
+
+    consecutive_failures?: number;
+
+    created_at?: string;
+
     /**
-     * Pagination metadata for list responses
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
      */
-    pagination?: WebhooksAPI.PaginationMeta;
+    customer_id?: string;
 
-    webhooks?: Array<WebhooksAPI.WebhookResponse>;
-  }
-}
+    display_name?: string;
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface WebhookListEventTypesResponse {
-  /**
-   * The response data (null if error)
-   */
-  data?: WebhookListEventTypesResponse.Data | null;
+    endpoint_url?: string;
+
+    event_filters?: { [key: string]: Array<string> } | null;
+
+    event_types?: Array<string>;
+
+    is_active?: boolean;
+
+    last_delivery_attempt_at?: string | null;
+
+    last_successful_delivery_at?: string | null;
+
+    retry_count?: number;
+
+    signing_secret?: string | null;
+
+    timeout_seconds?: number;
+
+    updated_at?: string | null;
+  }
 
   /**
    * Error information
    */
-  error?: ErrorDetail | null;
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
 
   /**
    * Request and response metadata
    */
-  meta?: APIMeta;
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
 
-  /**
-   * Indicates whether the request was successful
-   */
-  success?: boolean;
-}
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
 
-export namespace WebhookListEventTypesResponse {
-  /**
-   * The response data (null if error)
-   */
-  export interface Data {
-    event_types?: Array<WebhooksAPI.WebhookEventType>;
+    /**
+     * API version used for this request
+     */
+    version?: string;
   }
 }
 
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface WebhookListEventsResponse {
+export interface WebhookUpdateResponse {
   /**
    * The response data (null if error)
    */
-  data?: WebhookListEventsResponse.Data | null;
+  data?: WebhookUpdateResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: ErrorDetail | null;
+  error?: WebhookUpdateResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: APIMeta;
+  meta?: WebhookUpdateResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -795,18 +777,464 @@ export interface WebhookListEventsResponse {
   success?: boolean;
 }
 
-export namespace WebhookListEventsResponse {
+export namespace WebhookUpdateResponse {
   /**
    * The response data (null if error)
    */
   export interface Data {
-    events?: Array<Data.Event>;
+    id?: string;
+
+    consecutive_failures?: number;
+
+    created_at?: string;
 
     /**
-     * Pagination metadata for list responses
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
      */
-    pagination?: WebhooksAPI.PaginationMeta;
-  }
+    customer_id?: string;
+
+    display_name?: string;
+
+    endpoint_url?: string;
+
+    event_filters?: { [key: string]: Array<string> } | null;
+
+    event_types?: Array<string>;
+
+    is_active?: boolean;
+
+    last_delivery_attempt_at?: string | null;
+
+    last_successful_delivery_at?: string | null;
+
+    retry_count?: number;
+
+    signing_secret?: string | null;
+
+    timeout_seconds?: number;
+
+    updated_at?: string | null;
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface WebhookListResponse {
+  /**
+   * A paginated list of webhooks.
+   */
+  data?: WebhookListResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhookListResponse.Error | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhookListResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export namespace WebhookListResponse {
+  /**
+   * A paginated list of webhooks.
+   */
+  export interface Data {
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: Data.Pagination;
+
+    /**
+     * The webhooks on this page.
+     */
+    webhooks?: Array<Data.Webhook>;
+  }
+
+  export namespace Data {
+    /**
+     * Pagination metadata for list responses
+     */
+    export interface Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      cursors?: Pagination.Cursors | null;
+
+      /**
+       * Whether there are more pages after this one
+       */
+      has_more?: boolean;
+
+      /**
+       * Current page number (1-indexed)
+       */
+      page?: number;
+
+      /**
+       * Number of items per page
+       */
+      page_size?: number;
+
+      /**
+       * Total number of items across all pages
+       */
+      total_count?: number;
+
+      /**
+       * Total number of pages
+       */
+      total_pages?: number;
+    }
+
+    export namespace Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      export interface Cursors {
+        /**
+         * Cursor to fetch the next page.
+         */
+        after?: string | null;
+
+        /**
+         * Cursor to fetch the previous page.
+         */
+        before?: string | null;
+      }
+    }
+
+    export interface Webhook {
+      id?: string;
+
+      consecutive_failures?: number;
+
+      created_at?: string;
+
+      /**
+       * Which customer owns this — the key's own, or the profile named in x-profile-id.
+       * Says whose resource this is, which the resource's own id does not.
+       */
+      customer_id?: string;
+
+      display_name?: string;
+
+      endpoint_url?: string;
+
+      event_filters?: { [key: string]: Array<string> } | null;
+
+      event_types?: Array<string>;
+
+      is_active?: boolean;
+
+      last_delivery_attempt_at?: string | null;
+
+      last_successful_delivery_at?: string | null;
+
+      retry_count?: number;
+
+      signing_secret?: string | null;
+
+      timeout_seconds?: number;
+
+      updated_at?: string | null;
+    }
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface WebhookListEventTypesResponse {
+  /**
+   * The webhook event types a customer can subscribe to.
+   */
+  data?: WebhookListEventTypesResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhookListEventTypesResponse.Error | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhookListEventTypesResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export namespace WebhookListEventTypesResponse {
+  /**
+   * The webhook event types a customer can subscribe to.
+   */
+  export interface Data {
+    /**
+     * The event_types on this page.
+     */
+    event_types?: Array<Data.EventType>;
+
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: Data.Pagination;
+  }
+
+  export namespace Data {
+    export interface EventType {
+      description?: string | null;
+
+      display_name?: string;
+
+      event_type?: string | null;
+
+      is_active?: boolean;
+
+      name?: string;
+
+      sub_types?: Array<unknown> | null;
+    }
+
+    /**
+     * Pagination metadata for list responses
+     */
+    export interface Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      cursors?: Pagination.Cursors | null;
+
+      /**
+       * Whether there are more pages after this one
+       */
+      has_more?: boolean;
+
+      /**
+       * Current page number (1-indexed)
+       */
+      page?: number;
+
+      /**
+       * Number of items per page
+       */
+      page_size?: number;
+
+      /**
+       * Total number of items across all pages
+       */
+      total_count?: number;
+
+      /**
+       * Total number of pages
+       */
+      total_pages?: number;
+    }
+
+    export namespace Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      export interface Cursors {
+        /**
+         * Cursor to fetch the next page.
+         */
+        after?: string | null;
+
+        /**
+         * Cursor to fetch the previous page.
+         */
+        before?: string | null;
+      }
+    }
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface WebhookListEventsResponse {
+  /**
+   * A paginated list of webhook delivery records.
+   */
+  data?: WebhookListEventsResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhookListEventsResponse.Error | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhookListEventsResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export namespace WebhookListEventsResponse {
+  /**
+   * A paginated list of webhook delivery records.
+   */
+  export interface Data {
+    /**
+     * The events on this page.
+     */
+    events?: Array<Data.Event>;
+
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: Data.Pagination;
+  }
 
   export namespace Data {
     export interface Event {
@@ -838,6 +1266,103 @@ export namespace WebhookListEventsResponse {
 
       response_body?: string | null;
     }
+
+    /**
+     * Pagination metadata for list responses
+     */
+    export interface Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      cursors?: Pagination.Cursors | null;
+
+      /**
+       * Whether there are more pages after this one
+       */
+      has_more?: boolean;
+
+      /**
+       * Current page number (1-indexed)
+       */
+      page?: number;
+
+      /**
+       * Number of items per page
+       */
+      page_size?: number;
+
+      /**
+       * Total number of items across all pages
+       */
+      total_count?: number;
+
+      /**
+       * Total number of pages
+       */
+      total_pages?: number;
+    }
+
+    export namespace Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      export interface Cursors {
+        /**
+         * Cursor to fetch the next page.
+         */
+        after?: string | null;
+
+        /**
+         * Cursor to fetch the previous page.
+         */
+        before?: string | null;
+      }
+    }
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
   }
 }
 
@@ -853,12 +1378,12 @@ export interface WebhookRotateSecretResponse {
   /**
    * Error information
    */
-  error?: ErrorDetail | null;
+  error?: WebhookRotateSecretResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: APIMeta;
+  meta?: WebhookRotateSecretResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -873,6 +1398,51 @@ export namespace WebhookRotateSecretResponse {
   export interface Data {
     signing_secret?: string;
   }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
 }
 
 /**
@@ -887,12 +1457,12 @@ export interface WebhookTestResponse {
   /**
    * Error information
    */
-  error?: ErrorDetail | null;
+  error?: WebhookTestResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: APIMeta;
+  meta?: WebhookTestResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -909,6 +1479,162 @@ export namespace WebhookTestResponse {
 
     success?: boolean;
   }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface WebhookToggleStatusResponse {
+  /**
+   * The response data (null if error)
+   */
+  data?: WebhookToggleStatusResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: WebhookToggleStatusResponse.Error | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: WebhookToggleStatusResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export namespace WebhookToggleStatusResponse {
+  /**
+   * The response data (null if error)
+   */
+  export interface Data {
+    id?: string;
+
+    consecutive_failures?: number;
+
+    created_at?: string;
+
+    /**
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
+     */
+    customer_id?: string;
+
+    display_name?: string;
+
+    endpoint_url?: string;
+
+    event_filters?: { [key: string]: Array<string> } | null;
+
+    event_types?: Array<string>;
+
+    is_active?: boolean;
+
+    last_delivery_attempt_at?: string | null;
+
+    last_successful_delivery_at?: string | null;
+
+    retry_count?: number;
+
+    signing_secret?: string | null;
+
+    timeout_seconds?: number;
+
+    updated_at?: string | null;
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
 }
 
 export interface WebhookCreateParams {
@@ -1170,24 +1896,21 @@ export interface WebhookToggleStatusParams {
 
 export declare namespace Webhooks {
   export {
-    type APIMeta as APIMeta,
-    type APIResponseWebhook as APIResponseWebhook,
-    type ErrorDetail as ErrorDetail,
     type InboundMessageEvent as InboundMessageEvent,
     type InboundMessageEventPayload as InboundMessageEventPayload,
     type MessageEvent as MessageEvent,
     type MessageEventPayload as MessageEventPayload,
-    type MutationRequest as MutationRequest,
-    type PaginationMeta as PaginationMeta,
     type TemplateEvent as TemplateEvent,
     type TemplateEventPayload as TemplateEventPayload,
-    type WebhookEventType as WebhookEventType,
-    type WebhookResponse as WebhookResponse,
+    type WebhookCreateResponse as WebhookCreateResponse,
+    type WebhookRetrieveResponse as WebhookRetrieveResponse,
+    type WebhookUpdateResponse as WebhookUpdateResponse,
     type WebhookListResponse as WebhookListResponse,
     type WebhookListEventTypesResponse as WebhookListEventTypesResponse,
     type WebhookListEventsResponse as WebhookListEventsResponse,
     type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
     type WebhookTestResponse as WebhookTestResponse,
+    type WebhookToggleStatusResponse as WebhookToggleStatusResponse,
     type WebhookCreateParams as WebhookCreateParams,
     type WebhookRetrieveParams as WebhookRetrieveParams,
     type WebhookUpdateParams as WebhookUpdateParams,