@messagebird/sdk 0.42.0 → 0.43.0

package/dist/index.d.mts

@@ -47,6 +47,11 @@ interface CoreDefaults {
     value?: string;
     how: string;
   }>;
+  /**
+   * Set on a keyless (receiver-only) client: every API call throws this
+   * message as a `BirdMissingApiKeyError` before any request is built.
+   */
+  missingAuth?: string;
 }
 declare class BirdHTTPClient {
   private readonly defaults;
@@ -86,6 +91,13 @@ declare class BirdTimeoutError extends BirdError {
   readonly timeoutMs: number;
   constructor(message: string, timeoutMs: number);
 }
+/**
+ * An API call on a client constructed without `apiKey` (a receiver-only
+ * client, which can still `unwrap` webhooks). Thrown before any request.
+ */
+declare class BirdMissingApiKeyError extends BirdError {
+  constructor(message: string);
+}
 /** A webhook payload failed signature verification (bad signature, stale timestamp, malformed headers). */
 declare class BirdWebhookVerificationError extends BirdError {
   constructor(message: string);
@@ -1545,12 +1557,24 @@ type SmsSegments = {
    */
   readonly count: number;
   /**
-   * Encoding used for the body. The `GSM_7BIT` encoding fits 160 characters in one segment, or 153 per part in a multi-segment message. The `UCS2` encoding applies when the body contains a character outside the GSM 03.38 alphabet, including emoji, CJK, and some accented characters. It fits 70 characters in one segment, or 67 per part in a multi-segment message.
+   * Encoding used for the body. The `GSM_7BIT` encoding fits 160 septets
+   * (seven-bit units) in one segment, or 153 per part in a multi-segment
+   * message. The `UCS2` encoding applies when the body contains a character
+   * outside the GSM 03.38 alphabet, including emoji, CJK, and some accented
+   * characters. It fits 70 UTF-16 code units in one segment, or 67 per part.
+   *
+   * Neither limit counts characters, and both alphabets have characters that
+   * cost two units. Under `GSM_7BIT` there are ten such entries, and they are
+   * the whole set: `^`, `{`, `}`, `\`, `[`, `]`, `~`, `|`, `€`, and the form
+   * feed control. Eighty of those fill a single segment. Under `UCS2` an emoji
+   * outside the Basic Multilingual Plane is a surrogate pair costing two code
+   * units, so 35 of those fill a single segment.
    *
    */
   readonly encoding: "GSM_7BIT" | "UCS2";
   /**
-   * Character count of the body under the selected encoding.
+   * Character count of the body, counted in Unicode code points under either encoding. This is not the segment measure: a `GSM_7BIT` extended-table character counts once here but costs two septets, and a `UCS2` emoji outside the Basic Multilingual Plane counts once here but costs two of the segment's 70 code units.
+   *
    */
   readonly characters: number;
 };
@@ -6532,6 +6556,110 @@ type EmailMailboxLabel = {
 type EmailMailboxLabelList = {
   data: Array<EmailMailboxLabel>;
 };
+/**
+ * Field to sort webhook endpoints by: `created_at` (the default; newest first with the default `order`) or `url`.
+ *
+ */
+type WebhookSortField = "created_at" | "url";
+type WebhookEndpointId = string;
+/**
+ * Webhook event type. This is an open enum, so accept unrecognized values in deliveries. Subscribing to a type outside the event catalog returns a `422`.
+ *
+ */
+type WebhookEventType$1 = "domain.failed" | "domain.verified" | "email.accepted" | "email.bounced" | "email.canceled" | "email.clicked" | "email.complained" | "email.deferred" | "email.delivered" | "email.list_unsubscribed" | "email.opened" | "email.out_of_band_bounce" | "email.processed" | "email.received" | "email.rejected" | "email.scheduled" | "email.unsubscribed" | "email_mailbox.message_delivered" | "email_mailbox.message_failed" | "email_mailbox.message_received" | "email_mailbox.message_sent" | "email_mailbox.suspended" | "email_mailbox.thread_created" | "email_suppression.created" | "preference.deleted" | "preference.granted" | "preference.revoked" | "sms.accepted" | "sms.delivered" | "sms.expired" | "sms.failed" | "sms.received" | "sms.rejected" | "sms.sent" | "sms.undelivered" | "sms_suppression.created" | "verify.attempt.delivered" | "verify.attempt.sent" | "verify.attempt.undelivered" | "verify.verification.created" | "verify.verification.failed" | "verify.verification.verified" | "voice_call.answered" | "voice_call.ended" | "voice_call.initiated" | "whatsapp.accepted" | "whatsapp.delivered" | "whatsapp.failed" | "whatsapp.read" | "whatsapp.received" | "whatsapp.rejected" | "whatsapp.sent" | "whatsapp_suppression.created" | (string & {});
+type WebhookEndpoint = {
+  /**
+   * Unique identifier for the endpoint (`whk_` prefix). Accepted as `webhook_id` by every `/v1/webhooks/{webhook_id}` operation.
+   *
+   */
+  readonly id: WebhookEndpointId;
+  /**
+   * HTTPS URL where the API delivers events for this endpoint.
+   */
+  url: string;
+  /**
+   * Human-readable label for the endpoint.
+   */
+  description?: string;
+  /**
+   * Event types this endpoint is subscribed to; only matching events are delivered. Change the set with [Update a webhook endpoint](/docs/api/reference/update-webhook).
+   *
+   */
+  events: Array<WebhookEventType$1>;
+  /**
+   * Delivery state of the endpoint.
+   *
+   * - `active`: The initial state; events are being delivered normally.
+   * - `degraded`: Recent deliveries are failing. We keep delivering and retrying,
+   * and the endpoint returns to `active` automatically once deliveries succeed
+   * again.
+   * - `paused`: All delivery is stopped, either because an update set `status` to
+   * `paused` or automatically after sustained delivery failures. A paused endpoint
+   * never resumes on its own: re-enable it with
+   * [Update a webhook endpoint](/docs/api/reference/update-webhook), then recover
+   * the missed events with
+   * [Replay missed events](/docs/api/reference/create-webhook-replay).
+   *
+   */
+  readonly status: "active" | "degraded" | "paused";
+} & Timestamps;
+type WebhookEndpointCreate = {
+  /**
+   * HTTPS URL to deliver events to, at most 2048 characters. The host must be publicly reachable: URLs on private, loopback, or link-local addresses are rejected with a `422`.
+   *
+   */
+  url: string;
+  /**
+   * Event types to subscribe to; the endpoint receives only matching events. Types outside the event catalog return a `422`, and an endpoint holds at most 100 entries.
+   */
+  events: Array<WebhookEventType$1>;
+  /**
+   * Human-readable label for this endpoint, up to 256 characters.
+   */
+  description?: string;
+};
+type WebhookEndpointCreated = WebhookEndpoint & {
+  /**
+   * Signing secret for this endpoint (`whsec_` prefix), used to verify every delivery signature. Present in this response only: store it immediately, it cannot be retrieved again. If you lose it, mint a new one with [Rotate webhook signing secret](/docs/api/reference/rotate-webhook-secret).
+   *
+   */
+  secret: string;
+};
+type WebhookEndpointUpdate = {
+  /**
+   * Replacement delivery URL. Same rules as at creation: HTTPS, at most 2048 characters, and the host must be publicly reachable (private, loopback, and link-local addresses return a `422`). Omit to keep the current URL.
+   *
+   */
+  url?: string;
+  /**
+   * Human-readable label for this endpoint, up to 256 characters.
+   */
+  description?: string;
+  /**
+   * Replaces all event subscriptions with this list. Omit to keep the current set. Types outside the event catalog return a `422`.
+   *
+   */
+  events?: Array<WebhookEventType$1>;
+  /**
+   * `paused` stops all deliveries; `active` re-enables a paused endpoint. Omit to leave the status unchanged. Events that fire while paused are not delivered; after re-enabling, recover them with [Replay missed events](/docs/api/reference/create-webhook-replay). A `degraded` endpoint cannot be reset through this field: it returns to `active` automatically once deliveries succeed again.
+   *
+   */
+  status?: "active" | "paused";
+};
+type WebhookRotateSecretResponse = {
+  /**
+   * The new signing secret (`whsec_` prefix). Shown only in this response: store it immediately, it cannot be retrieved again. Deliveries are signed with both this and the previous secret for 24 hours after rotation, then the previous secret stops signing.
+   *
+   */
+  secret: string;
+};
+type WebhookTestRequest = {
+  /**
+   * Event type to simulate. Any type from the event catalog is accepted, whether or not the endpoint subscribes to it; an unknown type returns a `422`. When omitted, the endpoint's first subscribed event type is used.
+   *
+   */
+  event_type?: string;
+};
 /**
  * Payload of the domain.failed event.
  */
@@ -8375,6 +8503,88 @@ type EventWhatsAppSuppressionCreated = {
   timestamp: string;
   data: EventWhatsAppSuppressionCreatedData;
 };
+type WebhookTestResponse = {
+  /**
+   * Whether your endpoint accepted the test event. `delivered` means it returned a `2xx` status; `failed` means it returned a non-`2xx` status or could not be reached (see `error` for the latter).
+   *
+   */
+  status: "delivered" | "failed";
+  /**
+   * HTTP status returned by your endpoint. Null when no response was received (timeout, connection error, DNS failure).
+   */
+  response_status_code: number | null;
+  /**
+   * Response body returned by your endpoint, truncated to the first 1024 bytes. Omitted when your endpoint returned no body or could not be reached.
+   *
+   */
+  response_body?: string;
+  /**
+   * Round-trip delivery latency in milliseconds.
+   */
+  response_duration_ms: number;
+  /**
+   * The full event body delivered to your endpoint. Test sends use a minimal synthetic body rather than a full event payload, so this field is omitted.
+   *
+   */
+  event_payload?: WebhookEvent;
+  /**
+   * A short explanation of why the event could not be delivered. Present only when your endpoint could not be reached.
+   */
+  error?: string;
+};
+type WebhookEventId = string;
+type WebhookAttempt = {
+  /**
+   * Identifier of this individual delivery attempt. Each retry is a separate attempt with its own id; use `event_id` to group the attempts for one event.
+   *
+   */
+  readonly id: string;
+  /**
+   * Bird's source event ID, stable across retries of the same event. Null only for older attempts recorded before event IDs were available.
+   */
+  event_id?: WebhookEventId | null;
+  event_type: WebhookEventType$1;
+  /**
+   * Outcome of this attempt.
+   *
+   * - `delivered`: your endpoint accepted it with a `2xx` response.
+   * - `pending`: the attempt is still in flight.
+   * - `failed`: it returned a non-`2xx` response or no response at all. A `failed`
+   * attempt is not final for the event: automatic retries appear as further
+   * attempts with the same `event_id`.
+   *
+   */
+  status: "delivered" | "pending" | "failed";
+  /**
+   * URL the request was sent to: the endpoint's `url` at the time of the attempt, which can differ from the current configuration after an update.
+   *
+   */
+  url: string;
+  /**
+   * HTTP status returned by the receiver. Null when no response was received (timeout, connection error, DNS failure).
+   */
+  response_status_code: number | null;
+  /**
+   * Response body your endpoint returned, which may be truncated. Omitted when no body was returned.
+   *
+   */
+  response_body?: string;
+  /**
+   * Round-trip duration in milliseconds.
+   */
+  response_duration_ms: number;
+  /**
+   * When this attempt was made. Attempts are listed newest first by this timestamp, and the list's `before`/`after` parameters bound it.
+   *
+   */
+  readonly attempted_at: string;
+};
+type WebhookAttemptList = {
+  /**
+   * Delivery attempts, newest first.
+   */
+  data: Array<WebhookAttempt>;
+};
 /**
  * Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
  */
@@ -8686,7 +8896,7 @@ type PublishRealtimeAppEventData = {
   body: RealtimePublish;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -8717,7 +8927,7 @@ type PublishRealtimeAppBatchData = {
   body: RealtimeBatchPublish;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -8748,7 +8958,7 @@ type ListRealtimeAppChannelsData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -8774,7 +8984,7 @@ type GetRealtimeAppChannelData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -8800,7 +9010,7 @@ type SendRealtimeAppMemberEventData = {
   body: RealtimeMemberPublish;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -9427,7 +9637,7 @@ type ListSmsKeywordRulesData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -9464,7 +9674,7 @@ type CreateSmsKeywordRuleData = {
   body: SmsKeywordRuleCreate;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -9490,7 +9700,7 @@ type UpdateSmsKeywordRuleData = {
   body: SmsKeywordRuleUpdate;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10035,7 +10245,7 @@ type CreatePhoneNumberLookupData = {
   body: PhoneNumberLookupRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10061,7 +10271,7 @@ type CreateEmailLookupData = {
   body: EmailLookupRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10087,7 +10297,7 @@ type CreateVerificationData = {
   body: VerificationCreateRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10113,7 +10323,7 @@ type CreateVerificationCheckData = {
   body: VerificationCheckRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10139,7 +10349,7 @@ type CreateVerificationNextChannelData = {
   body: VerificationNextChannelRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -11346,11 +11556,140 @@ type ReplyEmailThreadMessageData = {
   query?: never;
   url: "/v1/email/threads/{thread_id}/messages/{message_id}/reply";
 };
+type ListWebhooksData = {
+  body?: never;
+  path?: never;
+  query?: {
+    sort?: WebhookSortField;
+    /**
+     * Sort direction. Defaults to `desc`, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
+     *
+     */
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of items to return per page.
+     */
+    limit?: number;
+    /**
+     * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
+     */
+    starting_after?: string;
+    /**
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
+     */
+    ending_before?: string;
+    /**
+     * When true, the response includes a `total` field with the total number of items matching the request's filters across all pages.
+     */
+    include_total?: boolean;
+  };
+  url: "/v1/webhooks";
+};
+type CreateWebhookData = {
+  body: WebhookEndpointCreate;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the original response is replayed for any duplicate request with the same key, within the idempotency window (3 hours by default).
+     *
+     * Two distinct 409 errors signal misuse:
+     *
+     * - `request_in_progress` (E01004): The same key is currently being
+     * processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005): The same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/webhooks";
+};
+type UpdateWebhookData = {
+  body: WebhookEndpointUpdate;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the original response is replayed for any duplicate request with the same key, within the idempotency window (3 hours by default).
+     *
+     * Two distinct 409 errors signal misuse:
+     *
+     * - `request_in_progress` (E01004): The same key is currently being
+     * processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005): The same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the webhook endpoint (`whk_` prefix), as returned when it was created.
+     */
+    webhook_id: WebhookEndpointId;
+  };
+  query?: never;
+  url: "/v1/webhooks/{webhook_id}";
+};
+type TestWebhookData = {
+  body?: WebhookTestRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the original response is replayed for any duplicate request with the same key, within the idempotency window (3 hours by default).
+     *
+     * Two distinct 409 errors signal misuse:
+     *
+     * - `request_in_progress` (E01004): The same key is currently being
+     * processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005): The same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the webhook endpoint (`whk_` prefix), as returned when it was created.
+     */
+    webhook_id: WebhookEndpointId;
+  };
+  query?: never;
+  url: "/v1/webhooks/{webhook_id}/test";
+};
+type ListWebhookAttemptsData = {
+  body?: never;
+  path: {
+    /**
+     * ID of the webhook endpoint (`whk_` prefix), as returned when it was created.
+     */
+    webhook_id: WebhookEndpointId;
+  };
+  query?: {
+    /**
+     * Maximum number of attempts to return. Defaults to 50, capped at 100.
+     */
+    limit?: number;
+    /**
+     * Only return attempts strictly before this timestamp.
+     */
+    before?: string;
+    /**
+     * Only return attempts strictly after this timestamp.
+     */
+    after?: string;
+  };
+  url: "/v1/webhooks/{webhook_id}/attempts";
+};
 type ListWorkspaceNumbersData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -11395,7 +11734,7 @@ type ListAvailableNumbersData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -11436,7 +11775,7 @@ type ListNumbersOrdersData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -11465,7 +11804,7 @@ type CreateNumbersOrderData = {
   body: NumbersOrderCreate;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -13374,6 +13713,93 @@ declare class VerifyResource {
   constructor(...args: ConstructorParameters<typeof Resource>);
 }
 //#endregion
+//#region src/resources/webhooks.gen.d.ts
+type WebhooksListQuery = NonNullable<ListWebhooksData["query"]>;
+type WebhooksCreateParams = NonNullable<CreateWebhookData["body"]>;
+type WebhooksTestParams = NonNullable<TestWebhookData["body"]>;
+type WebhooksAttemptsQuery = NonNullable<ListWebhookAttemptsData["query"]>;
+type WebhooksUpdateParams = NonNullable<UpdateWebhookData["body"]>;
+declare class WebhooksResourceBase extends Resource {
+  /**
+   * List the workspace's webhook endpoints (URL, subscribed events, status) as a cursor page.
+   *
+   * @example Iterate every webhook endpoint
+   * for await (const endpoint of bird.webhooks.list()) {
+   *   console.log(endpoint.id, endpoint.url, endpoint.status);
+   * }
+   */
+  list(query?: WebhooksListQuery, options?: RequestOptions): PaginatedPromise<WebhookEndpoint>;
+  /**
+   * Read one endpoint's URL, subscribed event types, and current delivery status. The signing secret is never included, and can only be rotated rather than retrieved.
+   *
+   * @example Fetch one endpoint by id
+   * const endpoint = await bird.webhooks.get("whk_01krdgeqcxet5s7t44vh8rt9mg");
+   * console.log(endpoint.url, endpoint.events);
+   */
+  get(webhookId: string, options?: RequestOptions): APIPromise<WebhookEndpoint>;
+  /**
+   * Register an HTTPS endpoint to receive this workspace's events, subscribed to the event types in `events` and active immediately. The response is the only place the signing secret appears, and it can never be read back afterward, only rotated.
+   *
+   * @example Subscribe an endpoint to events
+   * const created = await bird.webhooks.create({
+   *   url: "https://acme.com/hooks/bird",
+   *   events: ["email.delivered", "email.bounced"],
+   *   description: "Delivery pipeline",
+   * });
+   * console.log(created.id, created.secret);
+   */
+  create(params: WebhooksCreateParams, options?: RequestOptions): APIPromise<WebhookEndpointCreated>;
+  /**
+   * Send a signed synthetic event and get the outcome synchronously: whether the endpoint accepted, the HTTP status it returned, and the round-trip latency. An unreachable endpoint comes back as a failed status in the body rather than a request error. The receiver has 10 seconds, the body is a minimal stub carrying only the event type, and a test reaches even a paused endpoint without being recorded in the delivery attempts.
+   *
+   * @example Send a test event to an endpoint
+   * const result = await bird.webhooks.test("whk_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   event_type: "email.delivered",
+   * });
+   * console.log(result.status);
+   */
+  test(webhookId: string, params?: WebhooksTestParams, options?: RequestOptions): APIPromise<WebhookTestResponse>;
+  /**
+   * Permanently remove an endpoint and stop every delivery to it, including retries of earlier failures. Recreating it later mints a new ID and signing secret; to stop deliveries temporarily instead, set its status to `paused`.
+   *
+   * @example Stop delivery to an endpoint
+   * await bird.webhooks.delete("whk_01krdgeqcxet5s7t44vh8rt9mg");
+   */
+  delete(webhookId: string, options?: RequestOptions): APIPromise<void>;
+  /**
+   * List an endpoint's recent delivery attempts, newest first. Each entry is one HTTP request, so a retried event appears once per try. Pagination uses the `before`/`after` timestamps; page further back by passing the oldest `attempted_at` you received as `before`.
+   *
+   * @example Inspect recent delivery attempts
+   * const attempts = await bird.webhooks.attempts(
+   *   "whk_01krdgeqcxet5s7t44vh8rt9mg",
+   * );
+   * for (const attempt of attempts.data) {
+   *   console.log(attempt.status, attempt.response_status_code);
+   * }
+   */
+  attempts(webhookId: string, query?: WebhooksAttemptsQuery, options?: RequestOptions): APIPromise<WebhookAttemptList>;
+  /**
+   * Mint a new signing secret and return it exactly once; it cannot be retrieved afterward. Both the old and new secrets sign every delivery for 24 hours, after which the old one stops signing. An endpoint holds at most 5 valid secrets, so rotating repeatedly inside that window fails.
+   *
+   * @example Rotate an endpoint's signing secret
+   * const rotated = await bird.webhooks.rotateSecret(
+   *   "whk_01krdgeqcxet5s7t44vh8rt9mg",
+   * );
+   * console.log(rotated.secret);
+   */
+  rotateSecret(webhookId: string, options?: RequestOptions): APIPromise<WebhookRotateSecretResponse>;
+  /**
+   * Change an endpoint's URL, description, subscribed event types, or delivery status. Only the fields sent change: `events` replaces the whole subscription set, and `status` pauses or re-enables delivery. Events fired while paused are not delivered.
+   *
+   * @example Change the subscribed event types
+   * const endpoint = await bird.webhooks.update("whk_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   events: ["email.delivered"],
+   * });
+   * console.log(endpoint.events);
+   */
+  update(webhookId: string, params?: WebhooksUpdateParams, options?: RequestOptions): APIPromise<WebhookEndpoint>;
+}
+//#endregion
 //#region src/resources/webhooks.d.ts
 /** A verified webhook event, discriminated on `type`. */
 type BirdWebhookEvent = WebhookEvent;
@@ -13384,9 +13810,9 @@ interface WebhookOptions {
   /** Signing secret used by `unwrap`; a per-call `secret` overrides it. */
   secret?: string;
 }
-declare class WebhooksResource {
+declare class WebhooksResource extends WebhooksResourceBase {
   #private;
-  constructor(config?: WebhookOptions);
+  constructor(core: ConstructorParameters<typeof Resource>[0], client: ConstructorParameters<typeof Resource>[1], config?: WebhookOptions);
   /**
    * Verify a webhook delivery and return the typed event.
    *
@@ -13737,7 +14163,12 @@ declare class NumbersResource extends NumbersResourceBase {
 //#endregion
 //#region src/client.d.ts
 interface BirdClientOptions {
-  apiKey: string;
+  /**
+   * Required for API calls. A webhook receiver may omit it and configure only
+   * `webhooks: { secret }`; API methods on such a client throw
+   * {@link BirdMissingApiKeyError}.
+   */
+  apiKey?: string;
   /** Explicit base URL; overrides region resolution. For local/self-hosted use. */
   baseUrl?: string;
   /** Region override (e.g. `"eu1"`); the API key prefix is used by default. */
@@ -14301,5 +14732,5 @@ declare const WhatsAppTemplateParameterType: {
 /** A known WhatsAppTemplateParameterType value. */
 type WhatsAppTemplateParameterTypeValue = (typeof WhatsAppTemplateParameterType)[keyof typeof WhatsAppTemplateParameterType];
 //#endregion
-export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceCreateParams, type AudienceListContactsQuery, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type ChannelAuthorization, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type ContactsPreferencesListQuery, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, type EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, NumberCapability, type NumberCapabilityValue, NumberType, type NumberTypeValue, NumbersOrderStatus, type NumbersOrderStatusValue, type PaginatedPromise, type PhoneNumberLookup, type Preference, PreferenceChannel, type PreferenceChannelValue, type PreferenceCoverage, type PreferenceCreateParams, PreferenceOrigin, type PreferenceOriginValue, type PreferenceStatus, type PreferenceWriteResult, type PreferencesListQuery, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, SMSKeywordOperation, type SMSKeywordOperationValue, SMSSuppressionCoverage, type SMSSuppressionCoverageValue, SMSSuppressionEndReason, type SMSSuppressionEndReasonValue, SMSSuppressionOrigin, type SMSSuppressionOriginValue, SMSSuppressionReason, type SMSSuppressionReasonValue, type SafeResult, type SmsEventList, type SmsInboundStatsByCountryResponse, type SmsInboundStatsByNumberResponse, type SmsInboundStatsByOperatorResponse, type SmsInboundStatsResponse, type SmsInboundStatsSummaryResponse, type SmsKeywordRule, type SmsKeywordRuleList, type SmsKeywordRulesCreateParams, type SmsKeywordRulesListQuery, type SmsKeywordRulesUpdateParams, type SmsListEventsQuery, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsStatsByCarrierQuery, type SmsStatsByCarrierResponse, type SmsStatsByCategoryQuery, type SmsStatsByCategoryResponse, type SmsStatsByCountryQuery, type SmsStatsByCountryResponse, type SmsStatsByErrorCodeQuery, type SmsStatsByErrorCodeResponse, type SmsStatsByOriginatorQuery, type SmsStatsByOriginatorResponse, type SmsStatsByStatusQuery, type SmsStatsByStatusResponse, type SmsStatsDailyQuery, type SmsStatsHourlyQuery, type SmsStatsInboundByCountryQuery, type SmsStatsInboundByNumberQuery, type SmsStatsInboundByOperatorQuery, type SmsStatsInboundDailyQuery, type SmsStatsInboundHourlyQuery, type SmsStatsInboundSummaryQuery, type SmsStatsResponse, type SmsStatsSummary, type SmsStatsSummaryQuery, type SmsSuppression, type SmsSuppressionsAddParams, type SmsSuppressionsListQuery, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, type Workspace, baseUrlForRegion, regionFromApiKey };
+export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceCreateParams, type AudienceListContactsQuery, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdMissingApiKeyError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type ChannelAuthorization, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type ContactsPreferencesListQuery, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, type EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, NumberCapability, type NumberCapabilityValue, NumberType, type NumberTypeValue, NumbersOrderStatus, type NumbersOrderStatusValue, type PaginatedPromise, type PhoneNumberLookup, type Preference, PreferenceChannel, type PreferenceChannelValue, type PreferenceCoverage, type PreferenceCreateParams, PreferenceOrigin, type PreferenceOriginValue, type PreferenceStatus, type PreferenceWriteResult, type PreferencesListQuery, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, SMSKeywordOperation, type SMSKeywordOperationValue, SMSSuppressionCoverage, type SMSSuppressionCoverageValue, SMSSuppressionEndReason, type SMSSuppressionEndReasonValue, SMSSuppressionOrigin, type SMSSuppressionOriginValue, SMSSuppressionReason, type SMSSuppressionReasonValue, type SafeResult, type SmsEventList, type SmsInboundStatsByCountryResponse, type SmsInboundStatsByNumberResponse, type SmsInboundStatsByOperatorResponse, type SmsInboundStatsResponse, type SmsInboundStatsSummaryResponse, type SmsKeywordRule, type SmsKeywordRuleList, type SmsKeywordRulesCreateParams, type SmsKeywordRulesListQuery, type SmsKeywordRulesUpdateParams, type SmsListEventsQuery, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsStatsByCarrierQuery, type SmsStatsByCarrierResponse, type SmsStatsByCategoryQuery, type SmsStatsByCategoryResponse, type SmsStatsByCountryQuery, type SmsStatsByCountryResponse, type SmsStatsByErrorCodeQuery, type SmsStatsByErrorCodeResponse, type SmsStatsByOriginatorQuery, type SmsStatsByOriginatorResponse, type SmsStatsByStatusQuery, type SmsStatsByStatusResponse, type SmsStatsDailyQuery, type SmsStatsHourlyQuery, type SmsStatsInboundByCountryQuery, type SmsStatsInboundByNumberQuery, type SmsStatsInboundByOperatorQuery, type SmsStatsInboundDailyQuery, type SmsStatsInboundHourlyQuery, type SmsStatsInboundSummaryQuery, type SmsStatsResponse, type SmsStatsSummary, type SmsStatsSummaryQuery, type SmsSuppression, type SmsSuppressionsAddParams, type SmsSuppressionsListQuery, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, type WebhookAttemptList, type WebhookEndpoint, type WebhookEndpointCreated, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, type WebhookRotateSecretResponse, type WebhookTestResponse, type WebhooksAttemptsQuery, type WebhooksCreateParams, type WebhooksListQuery, type WebhooksTestParams, type WebhooksUpdateParams, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, type Workspace, baseUrlForRegion, regionFromApiKey };
 //# sourceMappingURL=index.d.mts.map