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

# Bulk Pause Webhooks

> Pause up to 100 webhooks at once.

Send a JSON array of webhook IDs. The response reports how many webhooks were paused, how many were already paused, how many IDs were not found, and how many were not valid IDs.


## OpenAPI

````yaml openapi/scheduler.yaml POST /agent-webhooks/pause-bulk/
openapi: 3.0.3
info:
  title: Lyzr Scheduler and Webhooks API
  version: 1.1.0
  description: >-
    Scheduler service for running Lyzr agents on cron schedules, triggering
    agents from external systems through signed webhooks, and calling arbitrary
    HTTP endpoints on a cron schedule.
servers:
  - url: https://scheduler.studio.lyzr.ai
security:
  - ApiKeyAuth: []
tags:
  - name: Schedules
    description: Run an agent on a cron schedule.
  - name: Agent Webhooks
    description: Create and manage webhook URLs that trigger an agent.
  - name: Webhook Trigger
    description: Public endpoint external services call to trigger an agent.
  - name: HTTP Schedules
    description: Call any HTTP endpoint on a cron schedule.
paths:
  /agent-webhooks/pause-bulk/:
    post:
      tags:
        - Agent Webhooks
      summary: Bulk pause webhooks
      description: Pause up to 100 webhooks at once.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              maxItems: 100
              description: Webhook IDs to pause.
              items:
                type: string
              example:
                - 66f1c3b7e4b0a1b2c3d4e5f7
                - 66f1c3b7e4b0a1b2c3d4e5fa
      responses:
        '200':
          description: Summary of the bulk pause.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPauseWebhookResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    BulkPauseWebhookResponse:
      type: object
      required:
        - message
        - total_requested
        - paused_count
        - already_paused_count
        - not_found_count
        - invalid_count
        - paused_webhooks
      properties:
        message:
          type: string
          description: Human-readable summary of the operation.
        total_requested:
          type: integer
          description: Number of webhook IDs submitted.
        paused_count:
          type: integer
          description: Number of webhooks paused by this request.
        already_paused_count:
          type: integer
          description: Number of webhooks that were already paused and were skipped.
        not_found_count:
          type: integer
          description: Number of IDs that did not match a webhook.
        invalid_count:
          type: integer
          description: Number of IDs that were not in a valid ID format.
        paused_webhooks:
          type: array
          description: Full details of the webhooks paused by this request.
          items:
            $ref: '#/components/schemas/WebhookResponse'
    WebhookResponse:
      type: object
      required:
        - id
        - agent_id
        - user_id
        - webhook_url
        - secret_key
        - created_at
      properties:
        id:
          type: string
          description: Unique webhook ID.
          example: 66f1c3b7e4b0a1b2c3d4e5f7
        agent_id:
          type: string
          example: 66e9b0f2a1c3d4e5f6a7b8c9
        user_id:
          type: string
          example: user@example.com
        description:
          type: string
          nullable: true
          example: New Zendesk ticket
        webhook_url:
          type: string
          description: Public URL external services call to trigger the agent.
          example: >-
            https://scheduler.studio.lyzr.ai/webhook-trigger/66f1c3b7e4b0a1b2c3d4e5f7
        secret_key:
          type: string
          description: >-
            Secret used to sign requests to `webhook_url` with HMAC-SHA256.
            Store it securely.
        is_active:
          type: boolean
          default: true
          description: '`false` when the webhook is paused.'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
        last_triggered_at:
          type: string
          format: date-time
          nullable: true
        last_trigger_success:
          type: boolean
          nullable: true
        trigger_count:
          type: integer
          default: 0
          description: Total number of times the webhook has been triggered.
    Error:
      type: object
      properties:
        detail:
          type: string
          example: Schedule not found
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            type: object
            properties:
              loc:
                type: array
                description: Path to the invalid field.
                items:
                  oneOf:
                    - type: string
                    - type: integer
              msg:
                type: string
                description: Human-readable error message.
              type:
                type: string
                description: Error type identifier.
  responses:
    Forbidden:
      description: The `x-api-key` header is missing or the key is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: Missing API key
              value:
                detail: API key missing
            invalid:
              summary: Invalid API key
              value:
                detail: Invalid Permission
    ValidationError:
      description: The request failed validation. The body lists each invalid field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Lyzr API key. Required on every endpoint except Trigger Webhook.

````