Webhooks

Models

BetaWebhookAgentArchivedEventData object{ 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

BetaWebhookAgentCreatedEventData object{ 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

BetaWebhookAgentDeletedEventData object{ 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

BetaWebhookAgentUpdatedEventData object{ 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

BetaWebhookDeploymentArchivedEventData object{ 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

BetaWebhookDeploymentCreatedEventData object{ 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

BetaWebhookDeploymentDeletedEventData object{ 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

BetaWebhookDeploymentPausedEventData object{ 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

BetaWebhookDeploymentRunFailedEventData object{ 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

BetaWebhookDeploymentRunStartedEventData object{ 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

BetaWebhookDeploymentRunSucceededEventData object{ 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

BetaWebhookDeploymentUnpausedEventData object{ 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

BetaWebhookDeploymentUpdatedEventData object{ 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

BetaWebhookEnvironmentArchivedEventData object{ 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

BetaWebhookEnvironmentCreatedEventData object{ 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

BetaWebhookEnvironmentDeletedEventData object{ 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

BetaWebhookEnvironmentUpdatedEventData object{ 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

BetaWebhookEvent object{ type: "event", id, created_at, data }

type: "event"

Object type. Always event for webhook payloads.

id: string

Unique event identifier for idempotency.

created_at: string

RFC 3339 timestamp when the event occurred.

formatdate-time

data: BetaWebhookEventData

One of the following:

BetaWebhookEventData = BetaWebhookSessionCreatedEventData or BetaWebhookSessionPendingEventData or BetaWebhookSessionRunningEventData or 41 more

One of the following:

BetaWebhookMemoryStoreArchivedEventData object{ 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

BetaWebhookMemoryStoreCreatedEventData object{ 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

BetaWebhookMemoryStoreDeletedEventData object{ 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

BetaWebhookSessionArchivedEventData object{ 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

BetaWebhookSessionBudgetReachedEventData object{ 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

BetaWebhookSessionCreatedEventData object{ 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

BetaWebhookSessionDeletedEventData object{ 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

BetaWebhookSessionIdledEventData object{ 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

BetaWebhookSessionOutcomeEvaluationEndedEventData object{ 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

BetaWebhookSessionPendingEventData object{ 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

BetaWebhookSessionRequiresActionEventData object{ 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

BetaWebhookSessionRunningEventData object{ 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

BetaWebhookSessionStatusIdledEventData object{ 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

BetaWebhookSessionStatusRescheduledEventData object{ 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

BetaWebhookSessionStatusRunStartedEventData object{ 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

BetaWebhookSessionStatusTerminatedEventData object{ 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

BetaWebhookSessionThreadCreatedEventData object{ 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

BetaWebhookSessionThreadIdledEventData object{ 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

BetaWebhookSessionThreadTerminatedEventData object{ 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

BetaWebhookSessionUpdatedEventData object{ 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

BetaWebhookVaultArchivedEventData object{ 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

BetaWebhookVaultCreatedEventData object{ 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

BetaWebhookVaultCredentialArchivedEventData object{ 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

BetaWebhookVaultCredentialCreatedEventData object{ 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

BetaWebhookVaultCredentialDeletedEventData object{ 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

BetaWebhookVaultCredentialRefreshFailedEventData object{ 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

BetaWebhookVaultDeletedEventData object{ 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