feat: Add webhook_config to batches.create() and models.generate_videos()

For dynamic per-request webhook notifications on batch jobs and video generation LROs.

PiperOrigin-RevId: 899099328

Author: MarkDaoust

api-report/genai-node.api.md

@@ -584,6 +584,7 @@ export interface CreateBatchJobConfig {
     dest?: BatchJobDestinationUnion;
     displayName?: string;
     httpOptions?: HttpOptions;
+    webhookConfig?: WebhookConfig;
 }
 
 // @public
@@ -1580,6 +1581,7 @@ export interface GenerateVideosConfig {
     referenceImages?: VideoGenerationReferenceImage[];
     resolution?: string;
     seed?: number;
+    webhookConfig?: WebhookConfig;
 }
 
 // @public
@@ -4210,6 +4212,12 @@ export interface VoiceConfig {
     replicatedVoiceConfig?: ReplicatedVoiceConfig;
 }
 
+// @public
+export interface WebhookConfig {
+    uris?: string[];
+    userMetadata?: Record<string, unknown>;
+}
+
 // Warning: (ae-forgotten-export) The symbol "BaseWebhooks" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)

api-report/genai-web.api.md

@@ -584,6 +584,7 @@ export interface CreateBatchJobConfig {
     dest?: BatchJobDestinationUnion;
     displayName?: string;
     httpOptions?: HttpOptions;
+    webhookConfig?: WebhookConfig;
 }
 
 // @public
@@ -1580,6 +1581,7 @@ export interface GenerateVideosConfig {
     referenceImages?: VideoGenerationReferenceImage[];
     resolution?: string;
     seed?: number;
+    webhookConfig?: WebhookConfig;
 }
 
 // @public
@@ -4210,6 +4212,12 @@ export interface VoiceConfig {
     replicatedVoiceConfig?: ReplicatedVoiceConfig;
 }
 
+// @public
+export interface WebhookConfig {
+    uris?: string[];
+    userMetadata?: Record<string, unknown>;
+}
+
 // Warning: (ae-forgotten-export) The symbol "BaseWebhooks" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)

api-report/genai.api.md

@@ -584,6 +584,7 @@ export interface CreateBatchJobConfig {
     dest?: BatchJobDestinationUnion;
     displayName?: string;
     httpOptions?: HttpOptions;
+    webhookConfig?: WebhookConfig;
 }
 
 // @public
@@ -1580,6 +1581,7 @@ export interface GenerateVideosConfig {
     referenceImages?: VideoGenerationReferenceImage[];
     resolution?: string;
     seed?: number;
+    webhookConfig?: WebhookConfig;
 }
 
 // @public
@@ -4210,6 +4212,12 @@ export interface VoiceConfig {
     replicatedVoiceConfig?: ReplicatedVoiceConfig;
 }
 
+// @public
+export interface WebhookConfig {
+    uris?: string[];
+    userMetadata?: Record<string, unknown>;
+}
+
 // Warning: (ae-forgotten-export) The symbol "BaseWebhooks" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)

src/converters/_batches_converters.ts

@@ -623,6 +623,17 @@ export function createBatchJobConfigToMldev(
     throw new Error('dest parameter is not supported in Gemini API.');
   }
 
+  const fromWebhookConfig = common.getValueByPath(fromObject, [
+    'webhookConfig',
+  ]);
+  if (parentObject !== undefined && fromWebhookConfig != null) {
+    common.setValueByPath(
+      parentObject,
+      ['batch', 'webhookConfig'],
+      fromWebhookConfig,
+    );
+  }
+
   return toObject;
 }
 
@@ -646,6 +657,10 @@ export function createBatchJobConfigToVertex(
     );
   }
 
+  if (common.getValueByPath(fromObject, ['webhookConfig']) !== undefined) {
+    throw new Error('webhookConfig parameter is not supported in Vertex AI.');
+  }
+
   return toObject;
 }
 

src/converters/_models_converters.ts

@@ -2771,6 +2771,13 @@ export function generateVideosConfigToMldev(
     throw new Error('labels parameter is not supported in Gemini API.');
   }
 
+  const fromWebhookConfig = common.getValueByPath(fromObject, [
+    'webhookConfig',
+  ]);
+  if (parentObject !== undefined && fromWebhookConfig != null) {
+    common.setValueByPath(parentObject, ['webhookConfig'], fromWebhookConfig);
+  }
+
   return toObject;
 }
 
@@ -2944,6 +2951,10 @@ export function generateVideosConfigToVertex(
     common.setValueByPath(parentObject, ['labels'], fromLabels);
   }
 
+  if (common.getValueByPath(fromObject, ['webhookConfig']) !== undefined) {
+    throw new Error('webhookConfig parameter is not supported in Vertex AI.');
+  }
+
   return toObject;
 }
 

src/types.ts

@@ -4476,6 +4476,20 @@ export declare interface VideoGenerationMask {
   maskMode?: VideoGenerationMaskMode;
 }
 
+/** Configuration for webhook notifications.
+
+Used to configure webhook endpoints that will receive notifications
+when long-running operations (e.g., batch jobs, video generation) complete. */
+export declare interface WebhookConfig {
+  /** The webhook URIs to receive notifications. If set, these
+      webhook URIs will be used instead of the registered webhooks. */
+  uris?: string[];
+  /** User metadata that will be included in each webhook event
+      notification. Use this to attach custom key-value data to correlate
+      webhook events with your internal systems. */
+  userMetadata?: Record<string, unknown>;
+}
+
 /** Configuration for generating videos. */
 export declare interface GenerateVideosConfig {
   /** Used to override HTTP request options. */
@@ -4534,6 +4548,9 @@ export declare interface GenerateVideosConfig {
   compressionQuality?: VideoCompressionQuality;
   /** User specified labels to track billing usage. */
   labels?: Record<string, string>;
+  /** Webhook configuration for receiving notifications when the
+      video generation operation completes. */
+  webhookConfig?: WebhookConfig;
 }
 
 /** Class that represents the parameters for generating videos. */
@@ -6248,6 +6265,10 @@ export declare interface CreateBatchJobConfig {
       "gs://path/to/output/data" or "bq://projectId.bqDatasetId.bqTableId".
        */
   dest?: BatchJobDestinationUnion;
+  /** Webhook configuration for receiving notifications when the batch
+      operation completes.
+       */
+  webhookConfig?: WebhookConfig;
 }
 
 /** Config for batches.create parameters. */