Webhooks

Models

class BetaWebhookAgentArchivedEventData { type = "agent.archived"; id; organizationId; workspaceId; }

JsonValue type = "agent.archived"

String id

ID of the agent that triggered the event.

String organizationId

String workspaceId

class BetaWebhookAgentCreatedEventData { type = "agent.created"; id; organizationId; workspaceId; }

JsonValue type = "agent.created"

String id

ID of the agent that triggered the event.

String organizationId

String workspaceId

class BetaWebhookAgentDeletedEventData { type = "agent.deleted"; id; organizationId; workspaceId; }

JsonValue type = "agent.deleted"

String id

ID of the agent that triggered the event.

String organizationId

String workspaceId

class BetaWebhookAgentUpdatedEventData { type = "agent.updated"; id; organizationId; workspaceId; }

JsonValue type = "agent.updated"

String id

ID of the agent that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentArchivedEventData { type = "deployment.archived"; id; organizationId; workspaceId; }

JsonValue type = "deployment.archived"

String id

ID of the deployment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentCreatedEventData { type = "deployment.created"; id; organizationId; workspaceId; }

JsonValue type = "deployment.created"

String id

ID of the deployment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentDeletedEventData { type = "deployment.deleted"; id; organizationId; workspaceId; }

JsonValue type = "deployment.deleted"

String id

ID of the deployment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentPausedEventData { type = "deployment.paused"; id; organizationId; workspaceId; }

JsonValue type = "deployment.paused"

String id

ID of the deployment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentRunFailedEventData { type = "deployment_run.failed"; id; organizationId; workspaceId; }

JsonValue type = "deployment_run.failed"

String id

ID of the deployment run that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentRunStartedEventData { type = "deployment_run.started"; id; organizationId; workspaceId; }

JsonValue type = "deployment_run.started"

String id

ID of the deployment run that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentRunSucceededEventData { type = "deployment_run.succeeded"; id; organizationId; workspaceId; }

JsonValue type = "deployment_run.succeeded"

String id

ID of the deployment run that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentUnpausedEventData { type = "deployment.unpaused"; id; organizationId; workspaceId; }

JsonValue type = "deployment.unpaused"

String id

ID of the deployment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookDeploymentUpdatedEventData { type = "deployment.updated"; id; organizationId; workspaceId; }

JsonValue type = "deployment.updated"

String id

ID of the deployment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookEnvironmentArchivedEventData { type = "environment.archived"; id; organizationId; workspaceId; }

JsonValue type = "environment.archived"

String id

ID of the environment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookEnvironmentCreatedEventData { type = "environment.created"; id; organizationId; workspaceId; }

JsonValue type = "environment.created"

String id

ID of the environment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookEnvironmentDeletedEventData { type = "environment.deleted"; id; organizationId; workspaceId; }

JsonValue type = "environment.deleted"

String id

ID of the environment that triggered the event.

String organizationId

String workspaceId

class BetaWebhookEnvironmentUpdatedEventData { type = "environment.updated"; id; organizationId; workspaceId; }

JsonValue type = "environment.updated"

String id

ID of the environment that triggered the event.

String organizationId

String workspaceId

class UnwrapWebhookEvent { type = "event"; id; createdAt; data; }

JsonValue type = "event"

Object type. Always event for webhook payloads.

String id

Unique event identifier for idempotency.

LocalDateTime createdAt

RFC 3339 timestamp when the event occurred.

formatdate-time

BetaWebhookEventData data

One of the following:

class BetaWebhookEventData: union

class BetaWebhookMemoryStoreArchivedEventData { type = "memory_store.archived"; id; organizationId; workspaceId; }

JsonValue type = "memory_store.archived"

String id

ID of the memory store that triggered the event.

String organizationId

String workspaceId

class BetaWebhookMemoryStoreCreatedEventData { type = "memory_store.created"; id; organizationId; workspaceId; }

JsonValue type = "memory_store.created"

String id

ID of the memory store that triggered the event.

String organizationId

String workspaceId

class BetaWebhookMemoryStoreDeletedEventData { type = "memory_store.deleted"; id; organizationId; workspaceId; }

JsonValue type = "memory_store.deleted"

String id

ID of the memory store that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionArchivedEventData { type = "session.archived"; id; organizationId; workspaceId; }

JsonValue type = "session.archived"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionBudgetReachedEventData { type = "session.budget_reached"; id; organizationId; workspaceId; }

JsonValue type = "session.budget_reached"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionCreatedEventData { type = "session.created"; id; organizationId; workspaceId; }

JsonValue type = "session.created"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionDeletedEventData { type = "session.deleted"; id; organizationId; workspaceId; }

JsonValue type = "session.deleted"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionIdledEventData { type = "session.idled"; id; organizationId; workspaceId; }

JsonValue type = "session.idled"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionOutcomeEvaluationEndedEventData { type = "session.outcome_evaluation_ended"; id; organizationId; workspaceId; }

JsonValue type = "session.outcome_evaluation_ended"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionPendingEventData { type = "session.pending"; id; organizationId; workspaceId; }

JsonValue type = "session.pending"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionRequiresActionEventData { type = "session.requires_action"; id; organizationId; workspaceId; }

JsonValue type = "session.requires_action"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionRunningEventData { type = "session.running"; id; organizationId; workspaceId; }

JsonValue type = "session.running"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionStatusIdledEventData { type = "session.status_idled"; id; organizationId; workspaceId; }

JsonValue type = "session.status_idled"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionStatusRescheduledEventData { type = "session.status_rescheduled"; id; organizationId; workspaceId; }

JsonValue type = "session.status_rescheduled"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionStatusRunStartedEventData { type = "session.status_run_started"; id; organizationId; workspaceId; }

JsonValue type = "session.status_run_started"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionStatusTerminatedEventData { type = "session.status_terminated"; id; organizationId; workspaceId; }

JsonValue type = "session.status_terminated"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookSessionThreadCreatedEventData { type = "session.thread_created"; id; organizationId; /* 2 more */ }

JsonValue type = "session.thread_created"

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 */ }

JsonValue type = "session.thread_idled"

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 */ }

JsonValue type = "session.thread_terminated"

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; }

JsonValue type = "session.updated"

String id

ID of the session that triggered the event.

String organizationId

String workspaceId

class BetaWebhookVaultArchivedEventData { type = "vault.archived"; id; organizationId; workspaceId; }

JsonValue type = "vault.archived"

String id

ID of the vault that triggered the event.

String organizationId

String workspaceId

class BetaWebhookVaultCreatedEventData { type = "vault.created"; id; organizationId; workspaceId; }

JsonValue type = "vault.created"

String id

ID of the vault that triggered the event.

String organizationId

String workspaceId

class BetaWebhookVaultCredentialArchivedEventData { type = "vault_credential.archived"; id; organizationId; /* 2 more */ }

JsonValue type = "vault_credential.archived"

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 */ }

JsonValue type = "vault_credential.created"

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 */ }

JsonValue type = "vault_credential.deleted"

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 */ }

JsonValue type = "vault_credential.refresh_failed"

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; }

JsonValue type = "vault.deleted"

String id

ID of the vault that triggered the event.

String organizationId

String workspaceId