Webhooks

Unwrap

client.beta.webhooks.unwrap(?): void

Models

BetaWebhookAgentArchivedEventData { id, organization_id, type, workspace_id }

id: string

ID of the agent that triggered the event.

organization_id: string

type: "agent.archived"

workspace_id: string

BetaWebhookAgentCreatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the agent that triggered the event.

organization_id: string

type: "agent.created"

workspace_id: string

BetaWebhookAgentDeletedEventData { id, organization_id, type, workspace_id }

id: string

ID of the agent that triggered the event.

organization_id: string

type: "agent.deleted"

workspace_id: string

BetaWebhookAgentUpdatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the agent that triggered the event.

organization_id: string

type: "agent.updated"

workspace_id: string

BetaWebhookDeploymentArchivedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment that triggered the event.

organization_id: string

type: "deployment.archived"

workspace_id: string

BetaWebhookDeploymentCreatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment that triggered the event.

organization_id: string

type: "deployment.created"

workspace_id: string

BetaWebhookDeploymentDeletedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment that triggered the event.

organization_id: string

type: "deployment.deleted"

workspace_id: string

BetaWebhookDeploymentPausedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment that triggered the event.

organization_id: string

type: "deployment.paused"

workspace_id: string

BetaWebhookDeploymentRunFailedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment run that triggered the event.

organization_id: string

type: "deployment_run.failed"

workspace_id: string

BetaWebhookDeploymentRunStartedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment run that triggered the event.

organization_id: string

type: "deployment_run.started"

workspace_id: string

BetaWebhookDeploymentRunSucceededEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment run that triggered the event.

organization_id: string

type: "deployment_run.succeeded"

workspace_id: string

BetaWebhookDeploymentUnpausedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment that triggered the event.

organization_id: string

type: "deployment.unpaused"

workspace_id: string

BetaWebhookDeploymentUpdatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the deployment that triggered the event.

organization_id: string

type: "deployment.updated"

workspace_id: string

BetaWebhookEnvironmentArchivedEventData { id, organization_id, type, workspace_id }

id: string

ID of the environment that triggered the event.

organization_id: string

type: "environment.archived"

workspace_id: string

BetaWebhookEnvironmentCreatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the environment that triggered the event.

organization_id: string

type: "environment.created"

workspace_id: string

BetaWebhookEnvironmentDeletedEventData { id, organization_id, type, workspace_id }

id: string

ID of the environment that triggered the event.

organization_id: string

type: "environment.deleted"

workspace_id: string

BetaWebhookEnvironmentUpdatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the environment that triggered the event.

organization_id: string

type: "environment.updated"

workspace_id: string

BetaWebhookEvent { id, created_at, data, type }

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: "event"

Object type. Always event for webhook payloads.

BetaWebhookEventData = BetaWebhookSessionCreatedEventData { id, organization_id, type, workspace_id } | BetaWebhookSessionPendingEventData { id, organization_id, type, workspace_id } | BetaWebhookSessionRunningEventData { id, organization_id, type, workspace_id } | 41 more

One of the following:

BetaWebhookMemoryStoreArchivedEventData { id, organization_id, type, workspace_id }

id: string

ID of the memory store that triggered the event.

organization_id: string

type: "memory_store.archived"

workspace_id: string

BetaWebhookMemoryStoreCreatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the memory store that triggered the event.

organization_id: string

type: "memory_store.created"

workspace_id: string

BetaWebhookMemoryStoreDeletedEventData { id, organization_id, type, workspace_id }

id: string

ID of the memory store that triggered the event.

organization_id: string

type: "memory_store.deleted"

workspace_id: string

BetaWebhookSessionArchivedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.archived"

workspace_id: string

BetaWebhookSessionBudgetReachedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.budget_reached"

workspace_id: string

BetaWebhookSessionCreatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.created"

workspace_id: string

BetaWebhookSessionDeletedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.deleted"

workspace_id: string

BetaWebhookSessionIdledEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.idled"

workspace_id: string

BetaWebhookSessionOutcomeEvaluationEndedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.outcome_evaluation_ended"

workspace_id: string

BetaWebhookSessionPendingEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.pending"

workspace_id: string

BetaWebhookSessionRequiresActionEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.requires_action"

workspace_id: string

BetaWebhookSessionRunningEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.running"

workspace_id: string

BetaWebhookSessionStatusIdledEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.status_idled"

workspace_id: string

BetaWebhookSessionStatusRescheduledEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.status_rescheduled"

workspace_id: string

BetaWebhookSessionStatusRunStartedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.status_run_started"

workspace_id: string

BetaWebhookSessionStatusTerminatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.status_terminated"

workspace_id: string

BetaWebhookSessionThreadCreatedEventData { id, organization_id, session_thread_id, 2 more }

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.

type: "session.thread_created"

workspace_id: string

BetaWebhookSessionThreadIdledEventData { id, organization_id, session_thread_id, 2 more }

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.

type: "session.thread_idled"

workspace_id: string

BetaWebhookSessionThreadTerminatedEventData { id, organization_id, session_thread_id, 2 more }

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.

type: "session.thread_terminated"

workspace_id: string

BetaWebhookSessionUpdatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the session that triggered the event.

organization_id: string

type: "session.updated"

workspace_id: string

BetaWebhookVaultArchivedEventData { id, organization_id, type, workspace_id }

id: string

ID of the vault that triggered the event.

organization_id: string

type: "vault.archived"

workspace_id: string

BetaWebhookVaultCreatedEventData { id, organization_id, type, workspace_id }

id: string

ID of the vault that triggered the event.

organization_id: string

type: "vault.created"

workspace_id: string

BetaWebhookVaultCredentialArchivedEventData { id, organization_id, type, 2 more }

id: string

ID of the vault credential that triggered the event.

organization_id: string

type: "vault_credential.archived"

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

BetaWebhookVaultCredentialCreatedEventData { id, organization_id, type, 2 more }

id: string

ID of the vault credential that triggered the event.

organization_id: string

type: "vault_credential.created"

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

BetaWebhookVaultCredentialDeletedEventData { id, organization_id, type, 2 more }

id: string

ID of the vault credential that triggered the event.

organization_id: string

type: "vault_credential.deleted"

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

BetaWebhookVaultCredentialRefreshFailedEventData { id, organization_id, type, 2 more }

id: string

ID of the vault credential that triggered the event.

organization_id: string

type: "vault_credential.refresh_failed"

vault_id: string

ID of the vault that owns this credential.

workspace_id: string

BetaWebhookVaultDeletedEventData { id, organization_id, type, workspace_id }

id: string

ID of the vault that triggered the event.

organization_id: string

type: "vault.deleted"

workspace_id: string

UnwrapWebhookEvent { id, created_at, data, type }

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: "event"

Object type. Always event for webhook payloads.