ARarize-ai
Webhooks

Get a webhook subscription

Changed on

Get a specific webhook subscription by its ID. A 404 is returned when the subscription does not exist, its source is not readable, or its webhook has since been deleted.

<Warning>This endpoint is in alpha, read more here.</Warning>

get/v2/webhook-subscriptions/{subscription_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/webhook-subscriptions/{subscription_id}
  • Auth
    HTTP bearer

Path parameters

subscription_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique webhook subscription identifier (base64)

Response

A webhook subscription object

idstring required

A universally unique identifier (base64-encoded opaque string).

webhook_idstring required

A universally unique identifier (base64-encoded opaque string).

source_type'PROMPT' | 'EVALUATOR' | 'ONLINE_TASK' | 'SPACE' required

The kind of resource a webhook subscription is attached to.

  • PROMPT — source_id is a prompt id. Prompt events apply.
  • EVALUATOR — source_id is an evaluator id. Evaluator events apply.
  • ONLINE_TASK — source_id is an evaluation task id. Task run events apply.
  • SPACE — source_id is a space id. Task run events apply to every evaluation task in the space, including tasks created later.
source_idstring required

A universally unique identifier (base64-encoded opaque string).

event'PROMPT_VERSION_CREATED' | 'PROMPT_VERSION_LABELED' | 'PROMPT_VERSION_UNLABELED' | 'EVALUATOR_VERSION_CREATED' | 'ONLINE_TASK_RUN_FAILED' required

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.
  • ONLINE_TASK_RUN_FAILED — a run of an evaluation task failed, or wrote some evaluations and then stopped on an error. Sent once when a task starts failing and again each time the cause changes.

Prompt events are valid only for PROMPT sources, evaluator events only for EVALUATOR sources, and task run events only for ONLINE_TASK and SPACE sources.

created_atstring date-time required

Timestamp for when the subscription was created

Example response

{
  "id": "RW50aXR5OjEyMzQ1",
  "webhook_id": "RW50aXR5OjEyMzQ1",
  "source_id": "RW50aXR5OjEyMzQ1"
}

Changes

  • 74723b1c4847Revision changes
    • warning

      added the new ONLINE_TASK enum value to the //// response property for the response status

    • warning

      added the new ONLINE_TASK_RUN_FAILED enum value to the //// response property for the response status

    • warning

      added the new SPACE enum value to the //// response property for the response status

  • 2a4c8244d07bRevision changes
    • info

      endpoint added