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

# Set an evaluator's webhook subscriptions

> Set (replace) all webhook subscriptions on an evaluator. This is an
idempotent operation.

**Payload Requirements**
- `subscriptions` is required, with at most one entry per `webhook_id`.
- Each entry must subscribe to at least one evaluator event
  (`EVALUATOR_VERSION_CREATED`); other events are rejected with a 422.
- Each `webhook_id` must be a webhook in the evaluator's organization;
  unknown webhooks yield a 404.
- At most 200 webhooks may subscribe to the same event on an
  evaluator; requests that would exceed this limit are rejected with a
  422.

Subscriptions not included in the request are removed. Pass an empty
array to detach every webhook from the evaluator.

<Warning>This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning>




## OpenAPI

````yaml https://api.arize.com/v2/spec.yaml put /v2/evaluators/{evaluator_id}/webhook-subscriptions
openapi: 3.0.3
info:
  title: Arize REST API
  version: 2.0.0
  description: |
    API specification for the backend data server. The API is hosted globally
    at https://api.arize.com/v2 or in your own environment.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - description: Global
    url: https://api.arize.com
  - description: Regional
    url: https://api.{region}.arize.com
    variables:
      region:
        default: eu-west-1a
        enum:
          - eu-west-1a
          - ca-central-1a
  - description: Custom Host
    url: https://{host}
    variables:
      host:
        default: api.arize.com
security:
  - bearerAuth: []
tags:
  - name: AI Integrations
    description: |
      AI integrations configure access to external LLM providers (e.g. OpenAI,
      Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
      entire account, a specific organization, or a specific space.
  - name: Annotation Configs
    description: >
      Annotation configs allow you to define consistent annotation schemas that

      can be reused across your workspace, ensuring evaluations are structured
      and

      comparable over time.
  - name: Annotation Queues
    description: >
      Annotation queues help you organize and manage human evaluation workflows.

      Use queues to assign spans or examples to annotators for review and
      labeling.
  - name: API Keys
    description: >
      API keys are used to authenticate requests to the Arize API. List your
      keys

      to view metadata; the raw secret is never returned after creation.
  - name: Audit Logs
    description: >
      Audit logs record authenticated user actions within an account, providing
      a

      chronological trail for security and compliance review. Access requires

      account admin privileges and audit logging to be enabled.
  - name: Datasets
    description: |
      Datasets are structured, version-controlled example collections you use to
      run, evaluate, and track LLM experiments.
  - name: Evaluators
    description: >
      Evaluators are reusable evaluation configurations used to assess the
      quality

      of LLM outputs. They can be template-based (using LLM judges) or
      code-based.
  - name: Experiments
    description: >
      Experiments let you systematically test prompt/model changes using
      datasets,

      tasks, and evaluators.
  - name: Integrations
    description: >
      Integrations configure access to external LLM providers (e.g. OpenAI,

      Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
      PagerDuty, Slack), and

      your own agents. Integrations can be scoped to the entire account, a
      specific

      organization, or a specific space.
  - name: Monitors
    description: >
      Monitors continuously track a metric over your model or LLM application
      data

      and alert you when it crosses a threshold. Each monitor watches a single

      metric - data quality, model performance, drift, a custom metric, or a

      tracing metric - and moves between statuses as the metric passes in and
      out of its 

      healthy range.
  - name: Organizations
    description: >
      Organizations are top-level containers within an Arize AX account for
      grouping spaces.
  - name: Projects
    description: |
      Projects represent LLM applications being monitored in Arize where you can
      observe traces and spans.
  - name: Prompts
    description: >
      Prompts are reusable, versioned templates for LLM interactions. Use
      prompts

      to standardize and manage how you interact with LLMs across your
      application.
  - name: Resource Restrictions
    description: |
      Endpoints for restricting and unrestricting resources (projects, models).
  - name: Role Bindings
    description: |
      Role bindings assign a role to a user on a resource. REST currently
      supports space- and project-scoped bindings.
  - name: Roles
    description: >
      Roles define sets of permissions that can be assigned to users within an

      account. Create custom roles to tailor access control to your team's
      needs.
  - name: Spaces
    description: >
      Spaces are containers within an organization for grouping related
      projects,

      datasets, and experiments, enabling collaboration or isolated
      experimentation

      with role-based access control.
  - name: Spans
    description: |
      Spans represent individual operations within a trace. A span captures the
      timing, status, and attributes of a single operation in your application.
  - name: Tags
    description: |
      Tags are reusable labels defined once per space and attached to resources
      across the platform, so the same vocabulary can be applied to projects,
      datasets, prompts, and more. Tags are shared: renaming or deleting a tag
      affects every resource it is attached to.
  - name: Tasks
    description: |
      Tasks are configurable units of work that tie one or more evaluators to a
      data source (project or dataset). Use tasks to automate evaluation of LLM
      outputs, with support for continuous evaluation and backfill runs.
  - name: Traces
    description: |
      A trace is the collection of spans sharing a trace ID, representing a
      single end-to-end request through an LLM application. Use the Traces
      endpoint to retrieve traces with all of their spans in one call.
  - name: Users
    description: >
      Users represent members of an account. The Users endpoints allow creating,

      listing, updating (display name), and removing users from the account
      programmatically.
  - name: Webhooks
    description: >
      Webhooks are organization-owned destinations that receive event deliveries

      over HTTPS. Deliveries are authenticated with a bearer token or signed
      with

      an HMAC signing secret — the secret is returned exactly once, when the

      webhook is created. Delivery attempts are recorded and can be listed for

      debugging. To choose which events a webhook receives, manage its

      subscriptions through the prompt and evaluator webhook-subscription

      endpoints.
paths:
  /v2/evaluators/{evaluator_id}/webhook-subscriptions:
    put:
      tags:
        - Evaluators
      summary: Set an evaluator's webhook subscriptions
      description: >
        Set (replace) all webhook subscriptions on an evaluator. This is an

        idempotent operation.


        **Payload Requirements**

        - `subscriptions` is required, with at most one entry per `webhook_id`.

        - Each entry must subscribe to at least one evaluator event
          (`EVALUATOR_VERSION_CREATED`); other events are rejected with a 422.
        - Each `webhook_id` must be a webhook in the evaluator's organization;
          unknown webhooks yield a 404.
        - At most 200 webhooks may subscribe to the same event on an
          evaluator; requests that would exceed this limit are rejected with a
          422.

        Subscriptions not included in the request are removed. Pass an empty

        array to detach every webhook from the evaluator.


        <Warning>This endpoint is in alpha, read more
        [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning>
      operationId: set_evaluator_webhook_subscriptions
      parameters:
        - $ref: '#/components/parameters/EvaluatorIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/SetWebhookSubscriptionsRequestBody'
      responses:
        '200':
          $ref: '#/components/responses/WebhookSubscriptions'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  parameters:
    EvaluatorIdPathParam:
      name: evaluator_id
      in: path
      required: true
      description: The unique evaluator identifier (base64)
      schema:
        $ref: '#/components/schemas/Id'
      example: RXZhbHVhdG9yOjEyMzQ1
  requestBodies:
    SetWebhookSubscriptionsRequestBody:
      description: >-
        Body containing the complete set of webhook subscriptions for the
        resource
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SetWebhookSubscriptionsRequest'
          examples:
            replace_prompt:
              summary: Replacing a prompt's subscriptions
              value:
                subscriptions:
                  - webhook_id: V2ViaG9vazoxMjM0NQ==
                    subscribed_events:
                      - PROMPT_VERSION_CREATED
                      - PROMPT_VERSION_LABELED
            replace_evaluator:
              summary: Replacing an evaluator's subscriptions
              value:
                subscriptions:
                  - webhook_id: V2ViaG9vazoxMjM0Ng==
                    subscribed_events:
                      - EVALUATOR_VERSION_CREATED
            detach_all:
              summary: Detaching every webhook from the resource
              value:
                subscriptions: []
  responses:
    WebhookSubscriptions:
      description: The complete set of webhook subscriptions attached to the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebhookSubscriptions'
          example:
            subscriptions:
              - webhook_id: V2ViaG9vazoxMjM0NQ==
                webhook_name: Prompt release notifications
                subscribed_events:
                  - PROMPT_VERSION_CREATED
                  - PROMPT_VERSION_LABELED
    BadRequest:
      description: Invalid request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 400
            title: Invalid request parameters
            detail: The 'name' field is required and must be a non-empty string.
            instance: /resource
            type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
    Unauthorized:
      description: Authentication is required
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 401
            title: Authentication required
            detail: You must be authenticated to access this resource.
            instance: /resource
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#authentication-required
    Forbidden:
      description: Insufficient permissions to access this resource
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 403
            title: Access forbidden
            detail: You do not have permission to access this resource.
            instance: /resource/12345
            type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
    NotFound:
      description: Not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 404
            title: Resource not found
            detail: The requested resource with ID '12345' was not found.
            instance: /resource/12345
            type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
    UnprocessableEntity:
      description: Unprocessable entity
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 422
            title: Unprocessable Entity
            detail: One or more fields failed validation.
            instance: /resource/12345
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity
    RateLimitExceeded:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: |
            When throttled (429), how long to wait before retrying. Value is
            either a delta-seconds integer.
          schema:
            type: integer
            minimum: 0
          example: 42
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 429
            title: Rate limit exceeded
            detail: >-
              You have exceeded the allowed number of requests. Please try again
              later.
            instance: /resource
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
  schemas:
    Id:
      type: string
      description: A universally unique identifier (base64-encoded opaque string).
      example: RW50aXR5OjEyMzQ1
    SetWebhookSubscriptionsRequest:
      type: object
      required:
        - subscriptions
      properties:
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/WebhookSubscriptionInput'
          minItems: 0
          description: >
            The complete set of webhook subscriptions for the resource, with at

            most one entry per `webhook_id`. Replaces all existing
            subscriptions:

            subscriptions not included in the request are removed, and an empty

            array detaches every webhook from the resource. At most 200 webhooks

            may subscribe to the same event on a resource; requests that would

            exceed this limit are rejected.
      additionalProperties: false
    WebhookSubscriptions:
      type: object
      required:
        - subscriptions
      properties:
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/WebhookSubscription'
          description: The webhooks attached to the resource and the events each receives
      description: The complete set of webhook subscriptions attached to a resource.
      additionalProperties: false
      x-forward-compatible: true
    Problem:
      type: object
      description: RFC 9457 Problem Details
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the problem
        type:
          type: string
          format: uri-reference
          description: A URI reference that identifies the problem type
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem
        instance:
          type: string
          format: uri-reference
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem
      required:
        - title
        - status
      additionalProperties: false
      x-forward-compatible: true
    WebhookSubscriptionInput:
      type: object
      required:
        - webhook_id
        - subscribed_events
      properties:
        webhook_id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: The unique identifier of the webhook to attach
        subscribed_events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
          minItems: 1
          description: >-
            The events to deliver to the webhook. Must contain at least one
            event valid for the resource type.
      additionalProperties: false
    WebhookSubscription:
      type: object
      required:
        - webhook_id
        - webhook_name
        - subscribed_events
      properties:
        webhook_id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: The unique identifier of the subscribed webhook
        webhook_name:
          type: string
          description: Name of the subscribed webhook
        subscribed_events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
          minItems: 1
          description: The events delivered to the webhook
      description: A webhook attached to a resource and the events it receives.
      additionalProperties: false
      x-forward-compatible: true
    WebhookEventType:
      type: string
      enum:
        - PROMPT_VERSION_CREATED
        - PROMPT_VERSION_LABELED
        - PROMPT_VERSION_UNLABELED
        - EVALUATOR_VERSION_CREATED
      description: >
        An event that a webhook can subscribe to.

        - `PROMPT_VERSION_CREATED` — a new version of the prompt was created.

        - `PROMPT_VERSION_LABELED` — a label was added to a version of the
        prompt.

        - `PROMPT_VERSION_UNLABELED` — a label was removed from a version of the
        prompt.

        - `EVALUATOR_VERSION_CREATED` — a new version of the evaluator was
        created.


        Prompt events are valid only for prompt subscriptions, and

        `EVALUATOR_VERSION_CREATED` only for evaluator subscriptions.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: <api-key>
      description: >
        Most Arize AI endpoints require authentication. For those endpoints that
        require authentication, include your API key in the request header using
        the format

        ``` Authorization: Bearer <api-key>

        ```

````