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

# Update a webhook endpoint

> Changes a webhook endpoint. Setting `active` to `true` also resumes an endpoint that CrewAI disabled after repeated failures.



## OpenAPI

````yaml /openapi/platform-v1.yaml patch /api/v1/webhook-endpoints/{id}
openapi: 3.0.1
info:
  title: CrewAI Platform API
  version: v1
  description: Supported public API for CrewAI Platform.
servers:
  - url: https://app.crewai.com
    description: Current CrewAI Platform host
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Users in the organization.
  - name: Status
    description: Platform health and API availability.
  - name: Automations
    description: Automations and their source artifacts.
  - name: Teams
    description: Teams in the organization.
  - name: Group Mappings
    description: Identity-provider group mappings to Teams.
  - name: Service Accounts
    description: Service accounts in the organization.
  - name: Webhook Endpoints
    description: Endpoints that receive signed event deliveries.
paths:
  /api/v1/webhook-endpoints/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
    patch:
      tags:
        - Webhook Endpoints
      summary: Update a webhook endpoint
      description: >-
        Changes a webhook endpoint. Setting `active` to `true` also resumes an
        endpoint that CrewAI disabled after repeated failures.
      operationId: updateWebhookEndpoint
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                url:
                  type: string
                  example: https://hooks.example.com/crewai
                  format: uri
                event_types:
                  type: array
                  items:
                    type: string
                    enum:
                      - automation_created
                      - automation_deployed
                      - automation_deployment_failed
                      - automation_redeployed
                  minItems: 1
                  uniqueItems: true
                  example:
                    - automation_created
                    - automation_deployed
                    - automation_deployment_failed
                  description: >
                    Events to deliver to the endpoint:

                    - `automation_created`: An Automation was created and is
                    provisioning.

                    - `automation_deployed`: An Automation came online for the
                    first time.

                    - `automation_deployment_failed`: An Automation's first
                    deployment failed.

                    - `automation_redeployed`: New code rolled out to an
                    Automation that was already deployed. A restart does not
                    count.
                description:
                  type: string
                  example: Tenant provisioning receiver
                  nullable: true
                active:
                  type: boolean
                  example: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                success:
                  value:
                    data:
                      id: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      url: https://hooks.example.com/crewai
                      description: Only creations
                      event_types:
                        - automation_created
                      active: true
                      disabled_at: null
                      created_at: '2026-07-07T00:00:00Z'
                      updated_at: '2026-07-07T00:00:00Z'
                  summary: Webhook endpoint updated
                resumed:
                  value:
                    data:
                      id: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      url: https://hooks.example.com/crewai
                      description: Tenant provisioning receiver
                      event_types:
                        - automation_created
                        - automation_deployed
                        - automation_deployment_failed
                      active: true
                      disabled_at: null
                      created_at: '2026-07-07T00:00:00Z'
                      updated_at: '2026-07-07T00:00:00Z'
                  summary: Webhook endpoint resumed after being disabled
              schema:
                type: object
                required:
                  - data
                additionalProperties: false
                properties:
                  data:
                    type: object
                    required:
                      - id
                      - url
                      - description
                      - event_types
                      - active
                      - disabled_at
                      - created_at
                      - updated_at
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      url:
                        type: string
                        example: https://hooks.example.com/crewai
                        format: uri
                      description:
                        type: string
                        example: Tenant provisioning receiver
                        nullable: true
                      event_types:
                        type: array
                        items:
                          type: string
                          enum:
                            - automation_created
                            - automation_deployed
                            - automation_deployment_failed
                            - automation_redeployed
                        minItems: 1
                        uniqueItems: true
                        example:
                          - automation_created
                          - automation_deployed
                          - automation_deployment_failed
                        description: >
                          Events to deliver to the endpoint:

                          - `automation_created`: An Automation was created and
                          is provisioning.

                          - `automation_deployed`: An Automation came online for
                          the first time.

                          - `automation_deployment_failed`: An Automation's
                          first deployment failed.

                          - `automation_redeployed`: New code rolled out to an
                          Automation that was already deployed. A restart does
                          not count.
                      active:
                        type: boolean
                        example: true
                      disabled_at:
                        type: string
                        format: date-time
                        example: null
                        nullable: true
                        description: >-
                          When CrewAI stopped delivering after repeated
                          failures. Set `active` to `true` to resume.
                      created_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/unauthorized
                        code: unauthorized
                        title: Unauthorized
                        status: 401
                        detail: Missing or invalid bearer token.
                  summary: Missing or invalid bearer token
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                not_found:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/not_found
                        code: not_found
                        title: Not found
                        status: 404
                        detail: The requested resource could not be found.
                  summary: Webhook endpoint not found
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              examples:
                invalid_url:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/validation_error
                        code: validation_error
                        title: Validation error
                        status: 422
                        detail: Url must use HTTPS
                  summary: URL is not HTTPS
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - errors
      additionalProperties: false
      properties:
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      description: Public API error object.
      required:
        - type
        - code
        - title
        - status
        - detail
      additionalProperties: false
      properties:
        type:
          type: string
          format: uri
          enum:
            - https://docs-platform.crewai.com/api/problems/bad_request
            - https://docs-platform.crewai.com/api/problems/clipper_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_disallowed
            - >-
              https://docs-platform.crewai.com/api/problems/clipper_feature_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_not_found
            - https://docs-platform.crewai.com/api/problems/conflict
            - https://docs-platform.crewai.com/api/problems/forbidden
            - https://docs-platform.crewai.com/api/problems/internal_error
            - https://docs-platform.crewai.com/api/problems/not_found
            - https://docs-platform.crewai.com/api/problems/service_unavailable
            - >-
              https://docs-platform.crewai.com/api/problems/tool_execution_failed
            - https://docs-platform.crewai.com/api/problems/unauthorized
            - https://docs-platform.crewai.com/api/problems/validation_error
          example: https://docs-platform.crewai.com/api/problems/bad_request
        code:
          type: string
          enum:
            - bad_request
            - clipper_disabled
            - clipper_disallowed
            - clipper_feature_disabled
            - clipper_not_found
            - conflict
            - forbidden
            - internal_error
            - not_found
            - service_unavailable
            - tool_execution_failed
            - unauthorized
            - validation_error
          example: bad_request
        title:
          type: string
          x-crewai-enum-format: freeform
          enum:
            - Bad request
            - Clipper resource disabled
            - Clipper resource disallowed
            - Clipper feature disabled
            - Clipper resource not found
            - Conflict
            - Forbidden
            - Internal error
            - Not found
            - Service unavailable
            - Tool execution failed
            - Unauthorized
            - Validation error
          example: Bad request
        status:
          type: integer
          enum:
            - 400
            - 401
            - 403
            - 404
            - 409
            - 422
            - 500
            - 503
          example: 400
        detail:
          type: string
          example: The request is invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque

````