Claude Platform Docs

Webhooks

Models
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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: Time

RFC 3339 timestamp when the event occurred.

formatdate-time
One of the following:
One of the following:
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class 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
class BetaWebhookUserProfileEnforcementActionOpenedEventData { type: :"user_profile.enforcement_action_opened", id, enforcement_action_id, organization_id }
type: :"user_profile.enforcement_action_opened"
id: String

ID of the user profile the enforcement action is on.

enforcement_action_id: String

ID (enac_...) of the enforcement action that was opened or resolved.

organization_id: String
class BetaWebhookUserProfileEnforcementActionResolvedEventData { type: :"user_profile.enforcement_action_resolved", id, enforcement_action_id, organization_id }
type: :"user_profile.enforcement_action_resolved"
id: String

ID of the user profile the enforcement action is on.

enforcement_action_id: String

ID (enac_...) of the enforcement action that was opened or resolved.

organization_id: String
class 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
class 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
class 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
class 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
class 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
class 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
class 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