Webhooks

import { listWebhooks } from "@arizeai/ax-client";

const { data: webhooks, pagination } = await listWebhooks({
  organization: "my-org",  // organization name or ID (optional)
  name: "deploy",          // case-insensitive substring filter on name (optional)
  limit: 10,
});

import { createWebhook } from "@arizeai/ax-client";

const webhook = await createWebhook({
  organization: "my-org",  // organization name or ID
  name: "Deploy Notifications",
  url: "https://example.com/hooks/arize",
  description: "Notifies our deploy pipeline",  // optional
  authType: "HMAC_SHA256",  // "BEARER" (default) or "HMAC_SHA256"; cannot be changed after creation
  authToken: "Bearer my-token",  // optional; only valid when authType is BEARER
  timeoutMs: 30000,  // optional, 1000-60000, defaults to 30000
  headers: { "X-Custom": "value" },  // optional custom headers, at most 20
});

// For HMAC_SHA256 webhooks, the signing secret is returned once:
console.log(webhook.signingSecret);

import { getWebhook } from "@arizeai/ax-client";

const webhook = await getWebhook({
  webhook: "Deploy Notifications",  // webhook name or ID
  organization: "my-org",           // required when resolving by webhook name
});

import { updateWebhook } from "@arizeai/ax-client";

const updated = await updateWebhook({
  webhook: "Deploy Notifications",  // webhook name or ID
  organization: "my-org",           // required when resolving by webhook name
  name: "Deploy Notifications v2",  // optional
  description: null,                // optional; pass null to clear
  url: "https://example.com/hooks/v2",  // optional
  authToken: "Bearer new-token",    // optional; BEARER webhooks only
  timeoutMs: 45000,                 // optional, 1000-60000
  headers: { "X-Custom": "value" }, // optional; replaces the whole header map
});

import { deleteWebhook } from "@arizeai/ax-client";

await deleteWebhook({
  webhook: "Deploy Notifications",  // webhook name or ID
  organization: "my-org",           // required when resolving by webhook name
});

import { testWebhook } from "@arizeai/ax-client";

const result = await testWebhook({
  webhook: "Deploy Notifications",  // webhook name or ID
  organization: "my-org",           // required when resolving by webhook name
});

import { listWebhookDeliveryAttempts } from "@arizeai/ax-client";

const { data: attempts, pagination } = await listWebhookDeliveryAttempts({
  webhook: "Deploy Notifications",  // webhook name or ID
  organization: "my-org",           // required when resolving by webhook name
  limit: 50,                        // optional, up to 500
});

import { listWebhookSubscriptions } from "@arizeai/ax-client";

const { data: subscriptions, pagination } = await listWebhookSubscriptions({
  sourceType: "PROMPT",         // optional; "PROMPT" or "EVALUATOR". Requires sourceId
  sourceId: "your_prompt_id",   // optional; requires sourceType
  limit: 10,
});

import { createWebhookSubscription } from "@arizeai/ax-client";

const subscription = await createWebhookSubscription({
  webhook: "Deploy Notifications",  // webhook name or ID
  organization: "my-org",           // required when resolving by webhook name
  sourceType: "PROMPT",             // "PROMPT" or "EVALUATOR"
  sourceId: "your_prompt_id",       // ID of the prompt or evaluator
  event: "PROMPT_VERSION_CREATED",  // must belong to sourceType
});

import { getWebhookSubscription } from "@arizeai/ax-client";

const subscription = await getWebhookSubscription({
  subscriptionId: "your_subscription_id",
});

import { deleteWebhookSubscription } from "@arizeai/ax-client";

await deleteWebhookSubscription({
  subscriptionId: "your_subscription_id",
});