Claude Platform Docs

Webhooks

Models
class BetaWebhookAgentArchivedEventData { $type = 'agent.archived'; $id; $organizationID; $workspaceID; }
"agent.archived" type
string id

ID of the agent that triggered the event.

string organizationID
string workspaceID
class BetaWebhookAgentCreatedEventData { $type = 'agent.created'; $id; $organizationID; $workspaceID; }
"agent.created" type
string id

ID of the agent that triggered the event.

string organizationID
string workspaceID
class BetaWebhookAgentDeletedEventData { $type = 'agent.deleted'; $id; $organizationID; $workspaceID; }
"agent.deleted" type
string id

ID of the agent that triggered the event.

string organizationID
string workspaceID
class BetaWebhookAgentUpdatedEventData { $type = 'agent.updated'; $id; $organizationID; $workspaceID; }
"agent.updated" type
string id

ID of the agent that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentArchivedEventData { $type = 'deployment.archived'; $id; $organizationID; $workspaceID; }
"deployment.archived" type
string id

ID of the deployment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentCreatedEventData { $type = 'deployment.created'; $id; $organizationID; $workspaceID; }
"deployment.created" type
string id

ID of the deployment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentDeletedEventData { $type = 'deployment.deleted'; $id; $organizationID; $workspaceID; }
"deployment.deleted" type
string id

ID of the deployment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentPausedEventData { $type = 'deployment.paused'; $id; $organizationID; $workspaceID; }
"deployment.paused" type
string id

ID of the deployment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentRunFailedEventData { $type = 'deployment_run.failed'; $id; $organizationID; $workspaceID; }
"deployment_run.failed" type
string id

ID of the deployment run that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentRunStartedEventData { $type = 'deployment_run.started'; $id; $organizationID; $workspaceID; }
"deployment_run.started" type
string id

ID of the deployment run that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentRunSucceededEventData { $type = 'deployment_run.succeeded'; $id; $organizationID; $workspaceID; }
"deployment_run.succeeded" type
string id

ID of the deployment run that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentUnpausedEventData { $type = 'deployment.unpaused'; $id; $organizationID; $workspaceID; }
"deployment.unpaused" type
string id

ID of the deployment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookDeploymentUpdatedEventData { $type = 'deployment.updated'; $id; $organizationID; $workspaceID; }
"deployment.updated" type
string id

ID of the deployment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookEnvironmentArchivedEventData { $type = 'environment.archived'; $id; $organizationID; $workspaceID; }
"environment.archived" type
string id

ID of the environment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookEnvironmentCreatedEventData { $type = 'environment.created'; $id; $organizationID; $workspaceID; }
"environment.created" type
string id

ID of the environment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookEnvironmentDeletedEventData { $type = 'environment.deleted'; $id; $organizationID; $workspaceID; }
"environment.deleted" type
string id

ID of the environment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookEnvironmentUpdatedEventData { $type = 'environment.updated'; $id; $organizationID; $workspaceID; }
"environment.updated" type
string id

ID of the environment that triggered the event.

string organizationID
string workspaceID
class BetaWebhookEvent { $type = 'event'; $id; $createdAt; $data; }
"event" type

Object type. Always event for webhook payloads.

string id

Unique event identifier for idempotency.

\Datetime createdAt

RFC 3339 timestamp when the event occurred.

class BetaWebhookEventData
One of the following:
class BetaWebhookMemoryStoreArchivedEventData { $type = 'memory_store.archived'; $id; $organizationID; $workspaceID; }
"memory_store.archived" type
string id

ID of the memory store that triggered the event.

string organizationID
string workspaceID
class BetaWebhookMemoryStoreCreatedEventData { $type = 'memory_store.created'; $id; $organizationID; $workspaceID; }
"memory_store.created" type
string id

ID of the memory store that triggered the event.

string organizationID
string workspaceID
class BetaWebhookMemoryStoreDeletedEventData { $type = 'memory_store.deleted'; $id; $organizationID; $workspaceID; }
"memory_store.deleted" type
string id

ID of the memory store that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionArchivedEventData { $type = 'session.archived'; $id; $organizationID; $workspaceID; }
"session.archived" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionBudgetReachedEventData { $type = 'session.budget_reached'; $id; $organizationID; $workspaceID; }
"session.budget_reached" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionCreatedEventData { $type = 'session.created'; $id; $organizationID; $workspaceID; }
"session.created" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionDeletedEventData { $type = 'session.deleted'; $id; $organizationID; $workspaceID; }
"session.deleted" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionIdledEventData { $type = 'session.idled'; $id; $organizationID; $workspaceID; }
"session.idled" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionOutcomeEvaluationEndedEventData { $type = 'session.outcome_evaluation_ended'; $id; $organizationID; $workspaceID; }
"session.outcome_evaluation_ended" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionPendingEventData { $type = 'session.pending'; $id; $organizationID; $workspaceID; }
"session.pending" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionRequiresActionEventData { $type = 'session.requires_action'; $id; $organizationID; $workspaceID; }
"session.requires_action" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionRunningEventData { $type = 'session.running'; $id; $organizationID; $workspaceID; }
"session.running" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionStatusIdledEventData { $type = 'session.status_idled'; $id; $organizationID; $workspaceID; }
"session.status_idled" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionStatusRescheduledEventData { $type = 'session.status_rescheduled'; $id; $organizationID; $workspaceID; }
"session.status_rescheduled" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionStatusRunStartedEventData { $type = 'session.status_run_started'; $id; $organizationID; $workspaceID; }
"session.status_run_started" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionStatusTerminatedEventData { $type = 'session.status_terminated'; $id; $organizationID; $workspaceID; }
"session.status_terminated" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookSessionThreadCreatedEventData { $type = 'session.thread_created'; $id; $organizationID; /* 2 more */ }
"session.thread_created" type
string id

ID of the session that triggered the event.

string organizationID
string sessionThreadID

ID of the session thread this event refers to.

string workspaceID
class BetaWebhookSessionThreadIdledEventData { $type = 'session.thread_idled'; $id; $organizationID; /* 2 more */ }
"session.thread_idled" type
string id

ID of the session that triggered the event.

string organizationID
string sessionThreadID

ID of the session thread this event refers to.

string workspaceID
class BetaWebhookSessionThreadTerminatedEventData { $type = 'session.thread_terminated'; $id; $organizationID; /* 2 more */ }
"session.thread_terminated" type
string id

ID of the session that triggered the event.

string organizationID
string sessionThreadID

ID of the session thread this event refers to.

string workspaceID
class BetaWebhookSessionUpdatedEventData { $type = 'session.updated'; $id; $organizationID; $workspaceID; }
"session.updated" type
string id

ID of the session that triggered the event.

string organizationID
string workspaceID
class BetaWebhookVaultArchivedEventData { $type = 'vault.archived'; $id; $organizationID; $workspaceID; }
"vault.archived" type
string id

ID of the vault that triggered the event.

string organizationID
string workspaceID
class BetaWebhookVaultCreatedEventData { $type = 'vault.created'; $id; $organizationID; $workspaceID; }
"vault.created" type
string id

ID of the vault that triggered the event.

string organizationID
string workspaceID
class BetaWebhookVaultCredentialArchivedEventData { $type = 'vault_credential.archived'; $id; $organizationID; /* 2 more */ }
"vault_credential.archived" type
string id

ID of the vault credential that triggered the event.

string organizationID
string vaultID

ID of the vault that owns this credential.

string workspaceID
class BetaWebhookVaultCredentialCreatedEventData { $type = 'vault_credential.created'; $id; $organizationID; /* 2 more */ }
"vault_credential.created" type
string id

ID of the vault credential that triggered the event.

string organizationID
string vaultID

ID of the vault that owns this credential.

string workspaceID
class BetaWebhookVaultCredentialDeletedEventData { $type = 'vault_credential.deleted'; $id; $organizationID; /* 2 more */ }
"vault_credential.deleted" type
string id

ID of the vault credential that triggered the event.

string organizationID
string vaultID

ID of the vault that owns this credential.

string workspaceID
class BetaWebhookVaultCredentialRefreshFailedEventData { $type = 'vault_credential.refresh_failed'; $id; $organizationID; /* 2 more */ }
"vault_credential.refresh_failed" type
string id

ID of the vault credential that triggered the event.

string organizationID
string vaultID

ID of the vault that owns this credential.

string workspaceID
class BetaWebhookVaultDeletedEventData { $type = 'vault.deleted'; $id; $organizationID; $workspaceID; }
"vault.deleted" type
string id

ID of the vault that triggered the event.

string organizationID
string workspaceID