List webhook subscriptions
Changed onList webhook subscriptions attached to prompts, evaluators, tasks and spaces the caller can read, most recently created first. To list one source, provide both source_type and source_id; providing only one returns a 400. An unfiltered list returns a 403 when the caller can read no prompt, evaluator or task at all.
Each subscription delivers one event to one webhook, so a webhook that receives several events from the source appears once per event. Subscriptions whose webhook has since been deleted, and task subscriptions on tasks the caller cannot read, are omitted after the page is read, so a page may hold fewer than limit items, or none, while has_more is still true. Keep paging until has_more is false.
When filtering by source, a 404 is returned when the source does not exist or is not readable.
<Warning>This endpoint is in alpha, read more here.</Warning>
Request
- Base URLhttps://api.arize.com
- URLhttps://api.arize.com/v2/webhook-subscriptions
- AuthHTTP bearer
Query parameters
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.
Filter subscriptions to one kind of source. Must be paired with source_id. When both filters are omitted, subscriptions from every supported source type are returned.
A universally unique identifier (base64-encoded opaque string).
Filter subscriptions to one prompt, evaluator, evaluation task, or space. Must be paired with source_type. When both filters are omitted, subscriptions from every readable supported source are returned.
Maximum items to return. Defaults to 50 if omitted; maximum is 100.
Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.
Response
Returns a list of webhook subscriptions, most recently created first
Example response
{
"subscriptions": [
{
"id": "RW50aXR5OjEyMzQ1",
"webhook_id": "RW50aXR5OjEyMzQ1",
"source_id": "RW50aXR5OjEyMzQ1"
}
]
}Changes
- warning
added the new
ONLINE_TASKenum value to the//////response property for the response status - warning
added the new
ONLINE_TASK_RUN_FAILEDenum value to the//////response property for the response status - warning
added the new
SPACEenum value to the//////response property for the response status - info
added the new enum value
ONLINE_TASKto thequeryrequest parametersource_type - info
added the new enum value
SPACEto thequeryrequest parametersource_type
- warning
- info
endpoint added
- info