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

# Change a webhook

> Change one of your webhooks' URL or events, or turn it off or on again; another member's is forbidden. A webhook turns itself off when its receiver answers 410 or fails 20 deliveries in a row; status active turns it back on and clears its failures. Events: job.needs_input (a job asks a question; the payload has its screened questions and the page where you answer), job.input_expiring (three minutes left to answer), job.succeeded and job.failed (a job settled). No event carries a result: read it from the job through the client that started it.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/webhooks/{id}
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: api_keys
    x-group: API keys
  - name: webhooks
    x-group: Webhooks
paths:
  /v1/webhooks/{id}:
    patch:
      tags:
        - webhooks
      summary: Change a webhook
      description: >-
        Change one of your webhooks' URL or events, or turn it off or on again;
        another member's is forbidden. A webhook turns itself off when its
        receiver answers 410 or fails 20 deliveries in a row; status active
        turns it back on and clears its failures. Events: job.needs_input (a job
        asks a question; the payload has its screened questions and the page
        where you answer), job.input_expiring (three minutes left to answer),
        job.succeeded and job.failed (a job settled). No event carries a result:
        read it from the job through the client that started it.
      operationId: webhooks.update
      parameters:
        - name: id
          in: path
          required: true
          description: 'a webhook ID: wh_ and 32 lowercase hex digits'
          schema:
            type: string
            examples:
              - wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              required: []
              properties:
                url:
                  type: string
                events:
                  type: array
                  items:
                    type: string
                    enum:
                      - job.needs_input
                      - job.input_expiring
                      - job.succeeded
                      - job.failed
                  description: an array of at least 1 item(s)
                  minItems: 1
                status:
                  type: string
                  enum:
                    - active
                    - disabled
                  description: >-
                    active turns a disabled webhook on again and clears its
                    failures; disabled turns it off
              additionalProperties: false
      responses:
        '200':
          description: The changed webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          description: invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: webhooks_unavailable, forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: request_too_large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    Webhook:
      type: object
      required:
        - id
        - created_by
        - url
        - events
        - status
        - disabled_reason
        - created_at
        - last_delivery_at
      properties:
        id:
          $ref: '#/components/schemas/webhook_id'
        created_by:
          $ref: '#/components/schemas/WebhookCreator'
        url:
          type: string
        events:
          type: array
          items:
            type: string
            enum:
              - job.needs_input
              - job.input_expiring
              - job.succeeded
              - job.failed
        status:
          type: string
          enum:
            - active
            - disabled
        disabled_reason:
          anyOf:
            - type: string
              enum:
                - manual
                - gone
                - unreachable
                - secret_unreadable
            - type: 'null'
          description: >-
            Why a disabled webhook sends nothing: manual (turned off), gone (its
            receiver answered 410), unreachable (20 failed deliveries in a row)
            or secret_unreadable (rotate its secret)
        created_at:
          $ref: '#/components/schemas/Date'
        last_delivery_at:
          anyOf:
            - $ref: '#/components/schemas/Date'
            - type: 'null'
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    webhook_id:
      type: string
      description: 'a webhook ID: wh_ and 32 lowercase hex digits'
      examples:
        - wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
    WebhookCreator:
      type: object
      required:
        - user_id
        - email
      properties:
        user_id:
          type: string
          description: The member's user ID
        email:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The email they sign in with, or null when the account no longer has
            it
      additionalProperties: false
      description: >-
        The member who made the webhook: only they change, test and rotate it,
        and it carries the events of the jobs they could see
    Date:
      type: string
      description: a string to be decoded into a Date
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.