Claude Platform Docs

Webhooks

Unwrap
beta.webhooks.unwrap()
Models
class BetaWebhookAgentArchivedEventData: …
id: str

ID of the agent that triggered the event.

organization_id: str
type: Literal["agent.archived"]
workspace_id: str
class BetaWebhookAgentCreatedEventData: …
id: str

ID of the agent that triggered the event.

organization_id: str
type: Literal["agent.created"]
workspace_id: str
class BetaWebhookAgentDeletedEventData: …
id: str

ID of the agent that triggered the event.

organization_id: str
type: Literal["agent.deleted"]
workspace_id: str
class BetaWebhookAgentUpdatedEventData: …
id: str

ID of the agent that triggered the event.

organization_id: str
type: Literal["agent.updated"]
workspace_id: str
class BetaWebhookDeploymentArchivedEventData: …
id: str

ID of the deployment that triggered the event.

organization_id: str
type: Literal["deployment.archived"]
workspace_id: str
class BetaWebhookDeploymentCreatedEventData: …
id: str

ID of the deployment that triggered the event.

organization_id: str
type: Literal["deployment.created"]
workspace_id: str
class BetaWebhookDeploymentDeletedEventData: …
id: str

ID of the deployment that triggered the event.

organization_id: str
type: Literal["deployment.deleted"]
workspace_id: str
class BetaWebhookDeploymentPausedEventData: …
id: str

ID of the deployment that triggered the event.

organization_id: str
type: Literal["deployment.paused"]
workspace_id: str
class BetaWebhookDeploymentRunFailedEventData: …
id: str

ID of the deployment run that triggered the event.

organization_id: str
type: Literal["deployment_run.failed"]
workspace_id: str
class BetaWebhookDeploymentRunStartedEventData: …
id: str

ID of the deployment run that triggered the event.

organization_id: str
type: Literal["deployment_run.started"]
workspace_id: str
class BetaWebhookDeploymentRunSucceededEventData: …
id: str

ID of the deployment run that triggered the event.

organization_id: str
type: Literal["deployment_run.succeeded"]
workspace_id: str
class BetaWebhookDeploymentUnpausedEventData: …
id: str

ID of the deployment that triggered the event.

organization_id: str
type: Literal["deployment.unpaused"]
workspace_id: str
class BetaWebhookDeploymentUpdatedEventData: …
id: str

ID of the deployment that triggered the event.

organization_id: str
type: Literal["deployment.updated"]
workspace_id: str
class BetaWebhookEnvironmentArchivedEventData: …
id: str

ID of the environment that triggered the event.

organization_id: str
type: Literal["environment.archived"]
workspace_id: str
class BetaWebhookEnvironmentCreatedEventData: …
id: str

ID of the environment that triggered the event.

organization_id: str
type: Literal["environment.created"]
workspace_id: str
class BetaWebhookEnvironmentDeletedEventData: …
id: str

ID of the environment that triggered the event.

organization_id: str
type: Literal["environment.deleted"]
workspace_id: str
class BetaWebhookEnvironmentUpdatedEventData: …
id: str

ID of the environment that triggered the event.

organization_id: str
type: Literal["environment.updated"]
workspace_id: str
class BetaWebhookEvent: …
id: str

Unique event identifier for idempotency.

created_at: datetime

RFC 3339 timestamp when the event occurred.

formatdate-time
data: BetaWebhookEventData
One of the following:
type: Literal["event"]

Object type. Always event for webhook payloads.

BetaWebhookEventData
One of the following:
class BetaWebhookMemoryStoreArchivedEventData: …
id: str

ID of the memory store that triggered the event.

organization_id: str
type: Literal["memory_store.archived"]
workspace_id: str
class BetaWebhookMemoryStoreCreatedEventData: …
id: str

ID of the memory store that triggered the event.

organization_id: str
type: Literal["memory_store.created"]
workspace_id: str
class BetaWebhookMemoryStoreDeletedEventData: …
id: str

ID of the memory store that triggered the event.

organization_id: str
type: Literal["memory_store.deleted"]
workspace_id: str
class BetaWebhookSessionArchivedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.archived"]
workspace_id: str
class BetaWebhookSessionBudgetReachedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.budget_reached"]
workspace_id: str
class BetaWebhookSessionCreatedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.created"]
workspace_id: str
class BetaWebhookSessionDeletedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.deleted"]
workspace_id: str
class BetaWebhookSessionIdledEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.idled"]
workspace_id: str
class BetaWebhookSessionOutcomeEvaluationEndedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.outcome_evaluation_ended"]
workspace_id: str
class BetaWebhookSessionPendingEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.pending"]
workspace_id: str
class BetaWebhookSessionRequiresActionEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.requires_action"]
workspace_id: str
class BetaWebhookSessionRunningEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.running"]
workspace_id: str
class BetaWebhookSessionStatusIdledEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.status_idled"]
workspace_id: str
class BetaWebhookSessionStatusRescheduledEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.status_rescheduled"]
workspace_id: str
class BetaWebhookSessionStatusRunStartedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.status_run_started"]
workspace_id: str
class BetaWebhookSessionStatusTerminatedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.status_terminated"]
workspace_id: str
class BetaWebhookSessionThreadCreatedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
session_thread_id: str

ID of the session thread this event refers to.

type: Literal["session.thread_created"]
workspace_id: str
class BetaWebhookSessionThreadIdledEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
session_thread_id: str

ID of the session thread this event refers to.

type: Literal["session.thread_idled"]
workspace_id: str
class BetaWebhookSessionThreadTerminatedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
session_thread_id: str

ID of the session thread this event refers to.

type: Literal["session.thread_terminated"]
workspace_id: str
class BetaWebhookSessionUpdatedEventData: …
id: str

ID of the session that triggered the event.

organization_id: str
type: Literal["session.updated"]
workspace_id: str
class BetaWebhookVaultArchivedEventData: …
id: str

ID of the vault that triggered the event.

organization_id: str
type: Literal["vault.archived"]
workspace_id: str
class BetaWebhookVaultCreatedEventData: …
id: str

ID of the vault that triggered the event.

organization_id: str
type: Literal["vault.created"]
workspace_id: str
class BetaWebhookVaultCredentialArchivedEventData: …
id: str

ID of the vault credential that triggered the event.

organization_id: str
type: Literal["vault_credential.archived"]
vault_id: str

ID of the vault that owns this credential.

workspace_id: str
class BetaWebhookVaultCredentialCreatedEventData: …
id: str

ID of the vault credential that triggered the event.

organization_id: str
type: Literal["vault_credential.created"]
vault_id: str

ID of the vault that owns this credential.

workspace_id: str
class BetaWebhookVaultCredentialDeletedEventData: …
id: str

ID of the vault credential that triggered the event.

organization_id: str
type: Literal["vault_credential.deleted"]
vault_id: str

ID of the vault that owns this credential.

workspace_id: str
class BetaWebhookVaultCredentialRefreshFailedEventData: …
id: str

ID of the vault credential that triggered the event.

organization_id: str
type: Literal["vault_credential.refresh_failed"]
vault_id: str

ID of the vault that owns this credential.

workspace_id: str
class BetaWebhookVaultDeletedEventData: …
id: str

ID of the vault that triggered the event.

organization_id: str
type: Literal["vault.deleted"]
workspace_id: str
class UnwrapWebhookEvent: …
id: str

Unique event identifier for idempotency.

created_at: datetime

RFC 3339 timestamp when the event occurred.

formatdate-time
data: BetaWebhookEventData
One of the following:
type: Literal["event"]

Object type. Always event for webhook payloads.