Claude Platform Docs

Webhooks

Models
type BetaWebhookAgentArchivedEventData struct { Type: "agent.archived"; ID; OrganizationID; WorkspaceID }
Type AgentArchived
ID string

ID of the agent that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookAgentCreatedEventData struct { Type: "agent.created"; ID; OrganizationID; WorkspaceID }
Type AgentCreated
ID string

ID of the agent that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookAgentDeletedEventData struct { Type: "agent.deleted"; ID; OrganizationID; WorkspaceID }
Type AgentDeleted
ID string

ID of the agent that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookAgentUpdatedEventData struct { Type: "agent.updated"; ID; OrganizationID; WorkspaceID }
Type AgentUpdated
ID string

ID of the agent that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentArchivedEventData struct { Type: "deployment.archived"; ID; OrganizationID; WorkspaceID }
Type DeploymentArchived
ID string

ID of the deployment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentCreatedEventData struct { Type: "deployment.created"; ID; OrganizationID; WorkspaceID }
Type DeploymentCreated
ID string

ID of the deployment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentDeletedEventData struct { Type: "deployment.deleted"; ID; OrganizationID; WorkspaceID }
Type DeploymentDeleted
ID string

ID of the deployment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentPausedEventData struct { Type: "deployment.paused"; ID; OrganizationID; WorkspaceID }
Type DeploymentPaused
ID string

ID of the deployment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentRunFailedEventData struct { Type: "deployment_run.failed"; ID; OrganizationID; WorkspaceID }
Type DeploymentRunFailed
ID string

ID of the deployment run that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentRunStartedEventData struct { Type: "deployment_run.started"; ID; OrganizationID; WorkspaceID }
Type DeploymentRunStarted
ID string

ID of the deployment run that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentRunSucceededEventData struct { Type: "deployment_run.succeeded"; ID; OrganizationID; WorkspaceID }
Type DeploymentRunSucceeded
ID string

ID of the deployment run that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentUnpausedEventData struct { Type: "deployment.unpaused"; ID; OrganizationID; WorkspaceID }
Type DeploymentUnpaused
ID string

ID of the deployment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookDeploymentUpdatedEventData struct { Type: "deployment.updated"; ID; OrganizationID; WorkspaceID }
Type DeploymentUpdated
ID string

ID of the deployment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookEnvironmentArchivedEventData struct { Type: "environment.archived"; ID; OrganizationID; WorkspaceID }
Type EnvironmentArchived
ID string

ID of the environment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookEnvironmentCreatedEventData struct { Type: "environment.created"; ID; OrganizationID; WorkspaceID }
Type EnvironmentCreated
ID string

ID of the environment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookEnvironmentDeletedEventData struct { Type: "environment.deleted"; ID; OrganizationID; WorkspaceID }
Type EnvironmentDeleted
ID string

ID of the environment that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookEnvironmentUpdatedEventData struct { Type: "environment.updated"; ID; OrganizationID; WorkspaceID }
Type EnvironmentUpdated
ID string

ID of the environment that triggered the event.

OrganizationID string
WorkspaceID string
type UnwrapWebhookEvent struct { Type: "event"; ID; CreatedAt; Data }
Type Event

Object type. Always event for webhook payloads.

ID string

Unique event identifier for idempotency.

CreatedAt Time

RFC 3339 timestamp when the event occurred.

formatdate-time
One of the following:
type BetaWebhookEventDataUnion interface{…}
One of the following:
type BetaWebhookMemoryStoreArchivedEventData struct { Type: "memory_store.archived"; ID; OrganizationID; WorkspaceID }
Type MemoryStoreArchived
ID string

ID of the memory store that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookMemoryStoreCreatedEventData struct { Type: "memory_store.created"; ID; OrganizationID; WorkspaceID }
Type MemoryStoreCreated
ID string

ID of the memory store that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookMemoryStoreDeletedEventData struct { Type: "memory_store.deleted"; ID; OrganizationID; WorkspaceID }
Type MemoryStoreDeleted
ID string

ID of the memory store that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionArchivedEventData struct { Type: "session.archived"; ID; OrganizationID; WorkspaceID }
Type SessionArchived
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionBudgetReachedEventData struct { Type: "session.budget_reached"; ID; OrganizationID; WorkspaceID }
Type SessionBudgetReached
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionCreatedEventData struct { Type: "session.created"; ID; OrganizationID; WorkspaceID }
Type SessionCreated
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionDeletedEventData struct { Type: "session.deleted"; ID; OrganizationID; WorkspaceID }
Type SessionDeleted
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionIdledEventData struct { Type: "session.idled"; ID; OrganizationID; WorkspaceID }
Type SessionIdled
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionOutcomeEvaluationEndedEventData struct { Type: "session.outcome_evaluation_ended"; ID; OrganizationID; WorkspaceID }
Type SessionOutcomeEvaluationEnded
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionPendingEventData struct { Type: "session.pending"; ID; OrganizationID; WorkspaceID }
Type SessionPending
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionRequiresActionEventData struct { Type: "session.requires_action"; ID; OrganizationID; WorkspaceID }
Type SessionRequiresAction
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionRunningEventData struct { Type: "session.running"; ID; OrganizationID; WorkspaceID }
Type SessionRunning
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionStatusIdledEventData struct { Type: "session.status_idled"; ID; OrganizationID; WorkspaceID }
Type SessionStatusIdled
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionStatusRescheduledEventData struct { Type: "session.status_rescheduled"; ID; OrganizationID; WorkspaceID }
Type SessionStatusRescheduled
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionStatusRunStartedEventData struct { Type: "session.status_run_started"; ID; OrganizationID; WorkspaceID }
Type SessionStatusRunStarted
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionStatusTerminatedEventData struct { Type: "session.status_terminated"; ID; OrganizationID; WorkspaceID }
Type SessionStatusTerminated
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookSessionThreadCreatedEventData struct { Type: "session.thread_created"; ID; OrganizationID; /* 2 more */ }
Type SessionThreadCreated
ID string

ID of the session that triggered the event.

OrganizationID string
SessionThreadID string

ID of the session thread this event refers to.

WorkspaceID string
type BetaWebhookSessionThreadIdledEventData struct { Type: "session.thread_idled"; ID; OrganizationID; /* 2 more */ }
Type SessionThreadIdled
ID string

ID of the session that triggered the event.

OrganizationID string
SessionThreadID string

ID of the session thread this event refers to.

WorkspaceID string
type BetaWebhookSessionThreadTerminatedEventData struct { Type: "session.thread_terminated"; ID; OrganizationID; /* 2 more */ }
Type SessionThreadTerminated
ID string

ID of the session that triggered the event.

OrganizationID string
SessionThreadID string

ID of the session thread this event refers to.

WorkspaceID string
type BetaWebhookSessionUpdatedEventData struct { Type: "session.updated"; ID; OrganizationID; WorkspaceID }
Type SessionUpdated
ID string

ID of the session that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookVaultArchivedEventData struct { Type: "vault.archived"; ID; OrganizationID; WorkspaceID }
Type VaultArchived
ID string

ID of the vault that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookVaultCreatedEventData struct { Type: "vault.created"; ID; OrganizationID; WorkspaceID }
Type VaultCreated
ID string

ID of the vault that triggered the event.

OrganizationID string
WorkspaceID string
type BetaWebhookVaultCredentialArchivedEventData struct { Type: "vault_credential.archived"; ID; OrganizationID; /* 2 more */ }
Type VaultCredentialArchived
ID string

ID of the vault credential that triggered the event.

OrganizationID string
VaultID string

ID of the vault that owns this credential.

WorkspaceID string
type BetaWebhookVaultCredentialCreatedEventData struct { Type: "vault_credential.created"; ID; OrganizationID; /* 2 more */ }
Type VaultCredentialCreated
ID string

ID of the vault credential that triggered the event.

OrganizationID string
VaultID string

ID of the vault that owns this credential.

WorkspaceID string
type BetaWebhookVaultCredentialDeletedEventData struct { Type: "vault_credential.deleted"; ID; OrganizationID; /* 2 more */ }
Type VaultCredentialDeleted
ID string

ID of the vault credential that triggered the event.

OrganizationID string
VaultID string

ID of the vault that owns this credential.

WorkspaceID string
type BetaWebhookVaultCredentialRefreshFailedEventData struct { Type: "vault_credential.refresh_failed"; ID; OrganizationID; /* 2 more */ }
Type VaultCredentialRefreshFailed
ID string

ID of the vault credential that triggered the event.

OrganizationID string
VaultID string

ID of the vault that owns this credential.

WorkspaceID string
type BetaWebhookVaultDeletedEventData struct { Type: "vault.deleted"; ID; OrganizationID; WorkspaceID }
Type VaultDeleted
ID string

ID of the vault that triggered the event.

OrganizationID string
WorkspaceID string