Claude Platform Docs

Webhooks

Models
class BetaWebhookAgentArchivedEventData:
required string ID

ID of the agent that triggered the event.

required string OrganizationID
JsonElement Type = "agent.archived"
required string WorkspaceID
class BetaWebhookAgentCreatedEventData:
required string ID

ID of the agent that triggered the event.

required string OrganizationID
JsonElement Type = "agent.created"
required string WorkspaceID
class BetaWebhookAgentDeletedEventData:
required string ID

ID of the agent that triggered the event.

required string OrganizationID
JsonElement Type = "agent.deleted"
required string WorkspaceID
class BetaWebhookAgentUpdatedEventData:
required string ID

ID of the agent that triggered the event.

required string OrganizationID
JsonElement Type = "agent.updated"
required string WorkspaceID
class BetaWebhookDeploymentArchivedEventData:
required string ID

ID of the deployment that triggered the event.

required string OrganizationID
JsonElement Type = "deployment.archived"
required string WorkspaceID
class BetaWebhookDeploymentCreatedEventData:
required string ID

ID of the deployment that triggered the event.

required string OrganizationID
JsonElement Type = "deployment.created"
required string WorkspaceID
class BetaWebhookDeploymentDeletedEventData:
required string ID

ID of the deployment that triggered the event.

required string OrganizationID
JsonElement Type = "deployment.deleted"
required string WorkspaceID
class BetaWebhookDeploymentPausedEventData:
required string ID

ID of the deployment that triggered the event.

required string OrganizationID
JsonElement Type = "deployment.paused"
required string WorkspaceID
class BetaWebhookDeploymentRunFailedEventData:
required string ID

ID of the deployment run that triggered the event.

required string OrganizationID
JsonElement Type = "deployment_run.failed"
required string WorkspaceID
class BetaWebhookDeploymentRunStartedEventData:
required string ID

ID of the deployment run that triggered the event.

required string OrganizationID
JsonElement Type = "deployment_run.started"
required string WorkspaceID
class BetaWebhookDeploymentRunSucceededEventData:
required string ID

ID of the deployment run that triggered the event.

required string OrganizationID
JsonElement Type = "deployment_run.succeeded"
required string WorkspaceID
class BetaWebhookDeploymentUnpausedEventData:
required string ID

ID of the deployment that triggered the event.

required string OrganizationID
JsonElement Type = "deployment.unpaused"
required string WorkspaceID
class BetaWebhookDeploymentUpdatedEventData:
required string ID

ID of the deployment that triggered the event.

required string OrganizationID
JsonElement Type = "deployment.updated"
required string WorkspaceID
class BetaWebhookEnvironmentArchivedEventData:
required string ID

ID of the environment that triggered the event.

required string OrganizationID
JsonElement Type = "environment.archived"
required string WorkspaceID
class BetaWebhookEnvironmentCreatedEventData:
required string ID

ID of the environment that triggered the event.

required string OrganizationID
JsonElement Type = "environment.created"
required string WorkspaceID
class BetaWebhookEnvironmentDeletedEventData:
required string ID

ID of the environment that triggered the event.

required string OrganizationID
JsonElement Type = "environment.deleted"
required string WorkspaceID
class BetaWebhookEnvironmentUpdatedEventData:
required string ID

ID of the environment that triggered the event.

required string OrganizationID
JsonElement Type = "environment.updated"
required string WorkspaceID
class UnwrapWebhookEvent:
required string ID

Unique event identifier for idempotency.

required DateTimeOffset CreatedAt

RFC 3339 timestamp when the event occurred.

formatdate-time
required BetaWebhookEventData Data
One of the following:
JsonElement Type = "event"

Object type. Always event for webhook payloads.

class BetaWebhookEventData: union
class BetaWebhookMemoryStoreArchivedEventData:
required string ID

ID of the memory store that triggered the event.

required string OrganizationID
JsonElement Type = "memory_store.archived"
required string WorkspaceID
class BetaWebhookMemoryStoreCreatedEventData:
required string ID

ID of the memory store that triggered the event.

required string OrganizationID
JsonElement Type = "memory_store.created"
required string WorkspaceID
class BetaWebhookMemoryStoreDeletedEventData:
required string ID

ID of the memory store that triggered the event.

required string OrganizationID
JsonElement Type = "memory_store.deleted"
required string WorkspaceID
class BetaWebhookSessionArchivedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.archived"
required string WorkspaceID
class BetaWebhookSessionBudgetReachedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.budget_reached"
required string WorkspaceID
class BetaWebhookSessionCreatedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.created"
required string WorkspaceID
class BetaWebhookSessionDeletedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.deleted"
required string WorkspaceID
class BetaWebhookSessionIdledEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.idled"
required string WorkspaceID
class BetaWebhookSessionOutcomeEvaluationEndedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.outcome_evaluation_ended"
required string WorkspaceID
class BetaWebhookSessionPendingEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.pending"
required string WorkspaceID
class BetaWebhookSessionRequiresActionEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.requires_action"
required string WorkspaceID
class BetaWebhookSessionRunningEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.running"
required string WorkspaceID
class BetaWebhookSessionStatusIdledEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.status_idled"
required string WorkspaceID
class BetaWebhookSessionStatusRescheduledEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.status_rescheduled"
required string WorkspaceID
class BetaWebhookSessionStatusRunStartedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.status_run_started"
required string WorkspaceID
class BetaWebhookSessionStatusTerminatedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.status_terminated"
required string WorkspaceID
class BetaWebhookSessionThreadCreatedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
required string SessionThreadID

ID of the session thread this event refers to.

JsonElement Type = "session.thread_created"
required string WorkspaceID
class BetaWebhookSessionThreadIdledEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
required string SessionThreadID

ID of the session thread this event refers to.

JsonElement Type = "session.thread_idled"
required string WorkspaceID
class BetaWebhookSessionThreadTerminatedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
required string SessionThreadID

ID of the session thread this event refers to.

JsonElement Type = "session.thread_terminated"
required string WorkspaceID
class BetaWebhookSessionUpdatedEventData:
required string ID

ID of the session that triggered the event.

required string OrganizationID
JsonElement Type = "session.updated"
required string WorkspaceID
class BetaWebhookVaultArchivedEventData:
required string ID

ID of the vault that triggered the event.

required string OrganizationID
JsonElement Type = "vault.archived"
required string WorkspaceID
class BetaWebhookVaultCreatedEventData:
required string ID

ID of the vault that triggered the event.

required string OrganizationID
JsonElement Type = "vault.created"
required string WorkspaceID
class BetaWebhookVaultCredentialArchivedEventData:
required string ID

ID of the vault credential that triggered the event.

required string OrganizationID
JsonElement Type = "vault_credential.archived"
required string VaultID

ID of the vault that owns this credential.

required string WorkspaceID
class BetaWebhookVaultCredentialCreatedEventData:
required string ID

ID of the vault credential that triggered the event.

required string OrganizationID
JsonElement Type = "vault_credential.created"
required string VaultID

ID of the vault that owns this credential.

required string WorkspaceID
class BetaWebhookVaultCredentialDeletedEventData:
required string ID

ID of the vault credential that triggered the event.

required string OrganizationID
JsonElement Type = "vault_credential.deleted"
required string VaultID

ID of the vault that owns this credential.

required string WorkspaceID
class BetaWebhookVaultCredentialRefreshFailedEventData:
required string ID

ID of the vault credential that triggered the event.

required string OrganizationID
JsonElement Type = "vault_credential.refresh_failed"
required string VaultID

ID of the vault that owns this credential.

required string WorkspaceID
class BetaWebhookVaultDeletedEventData:
required string ID

ID of the vault that triggered the event.

required string OrganizationID
JsonElement Type = "vault.deleted"
required string WorkspaceID