> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asteroid.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Batch Webhook Notification Payload

> Example endpoint to expose the execution batch webhook notification schema. This operation is for documentation purposes only.



## OpenAPI

````yaml https://odyssey.asteroid.ai/webhooks/openapi.json post /webhooks/example-batch
openapi: 3.1.0
info:
  title: Asteroid Webhook Notifications
  version: 0.0.0
servers: []
security: []
paths:
  /webhooks/example-batch:
    post:
      summary: Batch Webhook Notification Payload
      description: >-
        Example endpoint to expose the execution batch webhook notification
        schema. This operation is for documentation purposes only.
      operationId: WebhookSchemasExampleBatchWebhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Notifications.V2.ExecutionBatchNotificationV2
        required: true
      responses:
        '204':
          description: >-
            There is no content to send for this request, but the headers may be
            useful. 
components:
  schemas:
    Notifications.V2.ExecutionBatchNotificationV2:
      description: >-
        Top-level V2 notification structure sent to webhook endpoints for
        execution batch events
      properties:
        event_id:
          description: >-
            Unique identifier for this notification event. Stable across
            redeliveries of the same event.
          type: string
        info:
          allOf:
            - $ref: '#/components/schemas/Notifications.V2.ExecutionBatchInfo'
          description: Batch-specific information about the event
        timestamp:
          description: Timestamp when the event occurred
          format: date-time
          type: string
        type:
          description: >-
            The category of the notification. Always 'execution_batch' for batch
            events.
          enum:
            - execution_batch
          type: string
      required:
        - type
        - event_id
        - timestamp
        - info
      type: object
    Notifications.V2.ExecutionBatchInfo:
      description: Batch information with event-specific payload
      properties:
        agent_id:
          description: Agent identifier
          type: string
        agent_name:
          description: Agent name
          type: string
        batch_id:
          description: Unique identifier for the batch
          type: string
        batch_name:
          description: Batch name
          type: string
        batch_url:
          description: URL to view the batch in the Asteroid platform
          type: string
        event:
          allOf:
            - $ref: '#/components/schemas/Notifications.V2.ExecutionBatchEvent'
          description: The specific batch event type
        payload:
          anyOf:
            - $ref: >-
                #/components/schemas/Notifications.V2.ExecutionBatchStartedPayload
            - $ref: >-
                #/components/schemas/Notifications.V2.ExecutionBatchCompletedPayload
          description: >-
            Event-specific payload data. The structure depends on the 'event'
            field.
      required:
        - event
        - batch_id
        - batch_name
        - batch_url
        - agent_id
        - agent_name
        - payload
      type: object
    Notifications.V2.ExecutionBatchEvent:
      description: Execution batch event types.
      enum:
        - EXECUTION_BATCH_STARTED
        - EXECUTION_BATCH_COMPLETED
      type: string
    Notifications.V2.ExecutionBatchStartedPayload:
      description: Payload for EXECUTION_BATCH_STARTED events
      properties:
        item_count:
          description: Number of items in the batch
          type: integer
      required:
        - item_count
      title: EXECUTION_BATCH_STARTED
      type: object
    Notifications.V2.ExecutionBatchCompletedPayload:
      description: Payload for EXECUTION_BATCH_COMPLETED events
      properties:
        cancelled_count:
          description: Number of executions that were cancelled
          type: integer
        triggered_count:
          description: Number of executions that were triggered
          type: integer
      required:
        - triggered_count
        - cancelled_count
      title: EXECUTION_BATCH_COMPLETED
      type: object

````