> ## 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.

# Pause Webhook

> Stop a webhook from triggering its agent without deleting it.

The webhook keeps its URL and secret, so callers don't need to be reconfigured when you call [Resume Webhook](/enterprise/api/webhooks/agent-webhooks/resume).


## OpenAPI

````yaml openapi/scheduler.yaml POST /agent-webhooks/{webhook_id}/pause
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/{webhook_id}/pause:
    post:
      tags:
        - Agent Webhooks
      summary: Pause webhook
      description: Stop a webhook from triggering its agent without deleting it.
      parameters:
        - $ref: '#/components/parameters/WebhookId'
      responses:
        '200':
          description: The paused webhook.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    WebhookId:
      name: webhook_id
      in: path
      required: true
      description: ID of the webhook.
      schema:
        type: string
        example: 66f1c3b7e4b0a1b2c3d4e5f7
  schemas:
    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
    NotFound:
      description: No resource with this ID exists for your API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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.

````