Webhooks

Models

interface BetaWebhookAgentArchivedEventData { type: "agent.archived"; id; organization_id; workspace_id }

type: "agent.archived"

id: string

ID of the agent that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookAgentCreatedEventData { type: "agent.created"; id; organization_id; workspace_id }

type: "agent.created"

id: string

ID of the agent that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookAgentDeletedEventData { type: "agent.deleted"; id; organization_id; workspace_id }

type: "agent.deleted"

id: string

ID of the agent that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookAgentUpdatedEventData { type: "agent.updated"; id; organization_id; workspace_id }

type: "agent.updated"

id: string

ID of the agent that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentArchivedEventData { type: "deployment.archived"; id; organization_id; workspace_id }

type: "deployment.archived"

id: string

ID of the deployment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentCreatedEventData { type: "deployment.created"; id; organization_id; workspace_id }

type: "deployment.created"

id: string

ID of the deployment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentDeletedEventData { type: "deployment.deleted"; id; organization_id; workspace_id }

type: "deployment.deleted"

id: string

ID of the deployment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentPausedEventData { type: "deployment.paused"; id; organization_id; workspace_id }

type: "deployment.paused"

id: string

ID of the deployment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentRunFailedEventData { type: "deployment_run.failed"; id; organization_id; workspace_id }

type: "deployment_run.failed"

id: string

ID of the deployment run that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentRunStartedEventData { type: "deployment_run.started"; id; organization_id; workspace_id }

type: "deployment_run.started"

id: string

ID of the deployment run that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentRunSucceededEventData { type: "deployment_run.succeeded"; id; organization_id; workspace_id }

type: "deployment_run.succeeded"

id: string

ID of the deployment run that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentUnpausedEventData { type: "deployment.unpaused"; id; organization_id; workspace_id }

type: "deployment.unpaused"

id: string

ID of the deployment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookDeploymentUpdatedEventData { type: "deployment.updated"; id; organization_id; workspace_id }

type: "deployment.updated"

id: string

ID of the deployment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookEnvironmentArchivedEventData { type: "environment.archived"; id; organization_id; workspace_id }

type: "environment.archived"

id: string

ID of the environment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookEnvironmentCreatedEventData { type: "environment.created"; id; organization_id; workspace_id }

type: "environment.created"

id: string

ID of the environment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookEnvironmentDeletedEventData { type: "environment.deleted"; id; organization_id; workspace_id }

type: "environment.deleted"

id: string

ID of the environment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookEnvironmentUpdatedEventData { type: "environment.updated"; id; organization_id; workspace_id }

type: "environment.updated"

id: string

ID of the environment that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookEvent { type: "event"; id; created_at; data }

type: "event"

Object type. Always event for webhook payloads.

id: string

Unique event identifier for idempotency.

created_at: string

RFC 3339 timestamp when the event occurred.

formatdate-time

data: BetaWebhookEventData

One of the following:

type BetaWebhookEventData = BetaWebhookSessionCreatedEventData | BetaWebhookSessionPendingEventData | BetaWebhookSessionRunningEventData | 41 more

One of the following:

interface BetaWebhookMemoryStoreArchivedEventData { type: "memory_store.archived"; id; organization_id; workspace_id }

type: "memory_store.archived"

id: string

ID of the memory store that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookMemoryStoreCreatedEventData { type: "memory_store.created"; id; organization_id; workspace_id }

type: "memory_store.created"

id: string

ID of the memory store that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookMemoryStoreDeletedEventData { type: "memory_store.deleted"; id; organization_id; workspace_id }

type: "memory_store.deleted"

id: string

ID of the memory store that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionArchivedEventData { type: "session.archived"; id; organization_id; workspace_id }

type: "session.archived"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionBudgetReachedEventData { type: "session.budget_reached"; id; organization_id; workspace_id }

type: "session.budget_reached"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionCreatedEventData { type: "session.created"; id; organization_id; workspace_id }

type: "session.created"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionDeletedEventData { type: "session.deleted"; id; organization_id; workspace_id }

type: "session.deleted"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionIdledEventData { type: "session.idled"; id; organization_id; workspace_id }

type: "session.idled"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionOutcomeEvaluationEndedEventData { type: "session.outcome_evaluation_ended"; id; organization_id; workspace_id }

type: "session.outcome_evaluation_ended"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionPendingEventData { type: "session.pending"; id; organization_id; workspace_id }

type: "session.pending"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionRequiresActionEventData { type: "session.requires_action"; id; organization_id; workspace_id }

type: "session.requires_action"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionRunningEventData { type: "session.running"; id; organization_id; workspace_id }

type: "session.running"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionStatusIdledEventData { type: "session.status_idled"; id; organization_id; workspace_id }

type: "session.status_idled"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionStatusRescheduledEventData { type: "session.status_rescheduled"; id; organization_id; workspace_id }

type: "session.status_rescheduled"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionStatusRunStartedEventData { type: "session.status_run_started"; id; organization_id; workspace_id }

type: "session.status_run_started"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionStatusTerminatedEventData { type: "session.status_terminated"; id; organization_id; workspace_id }

type: "session.status_terminated"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookSessionThreadCreatedEventData { type: "session.thread_created"; id; organization_id; /* 2 more */ }

type: "session.thread_created"

id: string

ID of the session that triggered the event.

organization_id: string

session_thread_id: string

ID of the session thread this event refers to.

workspace_id: string

interface BetaWebhookSessionThreadIdledEventData { type: "session.thread_idled"; id; organization_id; /* 2 more */ }

type: "session.thread_idled"

id: string

ID of the session that triggered the event.

organization_id: string

session_thread_id: string

ID of the session thread this event refers to.

workspace_id: string

interface BetaWebhookSessionThreadTerminatedEventData { type: "session.thread_terminated"; id; organization_id; /* 2 more */ }

type: "session.thread_terminated"

id: string

ID of the session that triggered the event.

organization_id: string

session_thread_id: string

ID of the session thread this event refers to.

workspace_id: string

interface BetaWebhookSessionUpdatedEventData { type: "session.updated"; id; organization_id; workspace_id }

type: "session.updated"

id: string

ID of the session that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookVaultArchivedEventData { type: "vault.archived"; id; organization_id; workspace_id }

type: "vault.archived"

id: string

ID of the vault that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookVaultCreatedEventData { type: "vault.created"; id; organization_id; workspace_id }

type: "vault.created"

id: string

ID of the vault that triggered the event.

organization_id: string

workspace_id: string

interface BetaWebhookVaultCredentialArchivedEventData { type: "vault_credential.archived"; id; organization_id; /* 2 more */ }

type: "vault_credential.archived"

id: string

ID of the vault credential that triggered the event.

organization_id: string

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

interface BetaWebhookVaultCredentialCreatedEventData { type: "vault_credential.created"; id; organization_id; /* 2 more */ }

type: "vault_credential.created"

id: string

ID of the vault credential that triggered the event.

organization_id: string

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

interface BetaWebhookVaultCredentialDeletedEventData { type: "vault_credential.deleted"; id; organization_id; /* 2 more */ }

type: "vault_credential.deleted"

id: string

ID of the vault credential that triggered the event.

organization_id: string

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

interface BetaWebhookVaultCredentialRefreshFailedEventData { type: "vault_credential.refresh_failed"; id; organization_id; /* 2 more */ }

type: "vault_credential.refresh_failed"

id: string

ID of the vault credential that triggered the event.

organization_id: string

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

interface BetaWebhookVaultDeletedEventData { type: "vault.deleted"; id; organization_id; workspace_id }

type: "vault.deleted"

id: string

ID of the vault that triggered the event.

organization_id: string

workspace_id: string