Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Webhooks

Create Webhook Endpoint
client.Webhooks.New(ctx, body) (*WebhookEndpointWithSecret, error)
POST/webhook_endpoints
Delete Webhook Endpoint
client.Webhooks.Delete(ctx, webhookEndpointID) (*DeletedWebhookEndpoint, error)
DELETE/webhook_endpoints/{webhook_endpoint_id}
List Webhook Endpoints
client.Webhooks.List(ctx, query) (*CursorPage[WebhookEndpoint], error)
GET/webhook_endpoints
Retrieve Webhook Endpoint
client.Webhooks.Get(ctx, webhookEndpointID) (*WebhookEndpoint, error)
GET/webhook_endpoints/{webhook_endpoint_id}
Rotate Webhook Endpoint Signing Secret
client.Webhooks.RotateSecret(ctx, webhookEndpointID, body) (*WebhookEndpointWithSecret, error)
POST/webhook_endpoints/{webhook_endpoint_id}/rotate_secret
Test Webhook Endpoint
client.Webhooks.Test(ctx, webhookEndpointID, body) (*WebhookEndpointTestResult, error)
POST/webhook_endpoints/{webhook_endpoint_id}/test
Unwrap
client.Webhooks.Unwrap(ctx) error
Function
Update Webhook Endpoint
client.Webhooks.Update(ctx, webhookEndpointID, body) (*WebhookEndpoint, error)
POST/webhook_endpoints/{webhook_endpoint_id}
ModelsExpand Collapse
type AgentSessionActionRequiredWebhookEvent struct{…}

Sent when an agent session requires an action. Retrieve the session for action details.

type AgentSessionCreatedWebhookEvent struct{…}

Sent when an agent session is created.

type AgentSessionFailedWebhookEvent struct{…}

Sent when an agent session fails.

type AgentSessionIdleWebhookEvent struct{…}

Sent when an agent session becomes idle.

type AgentSessionInProgressWebhookEvent struct{…}

Sent when an agent session enters the in-progress state.

type BatchCancelledWebhookEvent struct{…}

Sent when a batch API request has been cancelled.

type BatchCompletedWebhookEvent struct{…}

Sent when a batch API request has been completed.

type BatchExpiredWebhookEvent struct{…}

Sent when a batch API request has expired.

type BatchFailedWebhookEvent struct{…}

Sent when a batch API request has failed.

type DeletedWebhookEndpoint struct{…}
type EvalRunCanceledWebhookEvent struct{…}

Sent when an eval run has been canceled.

type EvalRunFailedWebhookEvent struct{…}

Sent when an eval run has failed.

type EvalRunSucceededWebhookEvent struct{…}

Sent when an eval run has succeeded.

type FineTuningJobCancelledWebhookEvent struct{…}

Sent when a fine-tuning job has been cancelled.

type FineTuningJobFailedWebhookEvent struct{…}

Sent when a fine-tuning job has failed.

type FineTuningJobSucceededWebhookEvent struct{…}

Sent when a fine-tuning job has succeeded.

type LiveCallIncomingWebhookEvent struct{…}

Deprecated: use live.transport.incoming. Retained for existing subscriptions during migration; new subscriptions to this event are not allowed. Sent when an incoming API SIP session is available for Live acceptance. The same pending session can also emit realtime.call.incoming; the first successful Realtime or Live accept endpoint selects the runtime surface.

type LiveTransportIncomingWebhookEvent struct{…}

Sent when an incoming API SIP session is available for Live acceptance. The same pending session can also emit realtime.call.incoming; the first successful Realtime or Live accept endpoint selects the runtime surface.

type RealtimeCallIncomingWebhookEvent struct{…}

Sent when an incoming API SIP session is available for Realtime acceptance. The same pending session can also emit live.transport.incoming; the first successful Realtime or Live accept endpoint selects the runtime surface.

type ResponseCancelledWebhookEvent struct{…}

Sent when a background response has been cancelled.

type ResponseCompletedWebhookEvent struct{…}

Sent when a background response has been completed.

type ResponseFailedWebhookEvent struct{…}

Sent when a background response has failed.

type ResponseIncompleteWebhookEvent struct{…}

Sent when a background response has been interrupted.

type SafetyAlertCreatedWebhookEvent struct{…}

Sent when an approved safety alert is available for an API project.

type SafetyDeactivationIssuedWebhookEvent struct{…}

Sent when a deactivation is issued for a safety identifier in your organization.

type SafetyOrgAlertCreatedWebhookEvent struct{…}

Sent when an approved safety alert is available for an enterprise workspace.

type SafetyWarningIssuedWebhookEvent struct{…}

Sent when a warning is issued for a safety identifier in your organization.

type WebhookEndpoint struct{…}
type WebhookEndpointList struct{…}
type WebhookEndpointTestResult struct{…}
type WebhookEndpointWithSecret struct{…}
type WebhookEventTypeList struct{…}

WebhooksEvent Types

List Webhook Event Types
client.Webhooks.EventTypes.List(ctx) (*WebhookEventTypeList, error)
GET/webhook_event_types