Webhooks

Unwrap

beta.webhooks.unwrap() -> void

Parse Unverified

beta.webhooks.parse_unverified() -> void

Models

class BetaWebhookAgentArchivedEventData { id, organization_id, type, workspace_id }

id: String

ID of the agent that triggered the event.

organization_id: String

type: :"agent.archived"

workspace_id: String

class BetaWebhookAgentCreatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the agent that triggered the event.

organization_id: String

type: :"agent.created"

workspace_id: String

class BetaWebhookAgentDeletedEventData { id, organization_id, type, workspace_id }

id: String

ID of the agent that triggered the event.

organization_id: String

type: :"agent.deleted"

workspace_id: String

class BetaWebhookAgentUpdatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the agent that triggered the event.

organization_id: String

type: :"agent.updated"

workspace_id: String

class BetaWebhookDeploymentArchivedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment that triggered the event.

organization_id: String

type: :"deployment.archived"

workspace_id: String

class BetaWebhookDeploymentCreatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment that triggered the event.

organization_id: String

type: :"deployment.created"

workspace_id: String

class BetaWebhookDeploymentDeletedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment that triggered the event.

organization_id: String

type: :"deployment.deleted"

workspace_id: String

class BetaWebhookDeploymentPausedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment that triggered the event.

organization_id: String

type: :"deployment.paused"

workspace_id: String

class BetaWebhookDeploymentRunFailedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment run that triggered the event.

organization_id: String

type: :"deployment_run.failed"

workspace_id: String

class BetaWebhookDeploymentRunStartedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment run that triggered the event.

organization_id: String

type: :"deployment_run.started"

workspace_id: String

class BetaWebhookDeploymentRunSucceededEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment run that triggered the event.

organization_id: String

type: :"deployment_run.succeeded"

workspace_id: String

class BetaWebhookDeploymentUnpausedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment that triggered the event.

organization_id: String

type: :"deployment.unpaused"

workspace_id: String

class BetaWebhookDeploymentUpdatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the deployment that triggered the event.

organization_id: String

type: :"deployment.updated"

workspace_id: String

class BetaWebhookEnvironmentArchivedEventData { id, organization_id, type, workspace_id }

id: String

ID of the environment that triggered the event.

organization_id: String

type: :"environment.archived"

workspace_id: String

class BetaWebhookEnvironmentCreatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the environment that triggered the event.

organization_id: String

type: :"environment.created"

workspace_id: String

class BetaWebhookEnvironmentDeletedEventData { id, organization_id, type, workspace_id }

id: String

ID of the environment that triggered the event.

organization_id: String

type: :"environment.deleted"

workspace_id: String

class BetaWebhookEnvironmentUpdatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the environment that triggered the event.

organization_id: String

type: :"environment.updated"

workspace_id: String

class BetaWebhookEvent { id, created_at, data, type }

id: String

Unique event identifier for idempotency.

created_at: Time

RFC 3339 timestamp when the event occurred.

formatdate-time

data: BetaWebhookEventData

One of the following:

type: :event

Object type. Always event for webhook payloads.

BetaWebhookEventData = BetaWebhookSessionCreatedEventData { id, organization_id, type, workspace_id } | BetaWebhookSessionPendingEventData { id, organization_id, type, workspace_id } | BetaWebhookSessionRunningEventData { id, organization_id, type, workspace_id } | 41 more

One of the following:

class BetaWebhookMemoryStoreArchivedEventData { id, organization_id, type, workspace_id }

id: String

ID of the memory store that triggered the event.

organization_id: String

type: :"memory_store.archived"

workspace_id: String

class BetaWebhookMemoryStoreCreatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the memory store that triggered the event.

organization_id: String

type: :"memory_store.created"

workspace_id: String

class BetaWebhookMemoryStoreDeletedEventData { id, organization_id, type, workspace_id }

id: String

ID of the memory store that triggered the event.

organization_id: String

type: :"memory_store.deleted"

workspace_id: String

class BetaWebhookSessionArchivedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.archived"

workspace_id: String

class BetaWebhookSessionBudgetReachedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.budget_reached"

workspace_id: String

class BetaWebhookSessionCreatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.created"

workspace_id: String

class BetaWebhookSessionDeletedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.deleted"

workspace_id: String

class BetaWebhookSessionIdledEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.idled"

workspace_id: String

class BetaWebhookSessionOutcomeEvaluationEndedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.outcome_evaluation_ended"

workspace_id: String

class BetaWebhookSessionPendingEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.pending"

workspace_id: String

class BetaWebhookSessionRequiresActionEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.requires_action"

workspace_id: String

class BetaWebhookSessionRunningEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.running"

workspace_id: String

class BetaWebhookSessionStatusIdledEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.status_idled"

workspace_id: String

class BetaWebhookSessionStatusRescheduledEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.status_rescheduled"

workspace_id: String

class BetaWebhookSessionStatusRunStartedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.status_run_started"

workspace_id: String

class BetaWebhookSessionStatusTerminatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.status_terminated"

workspace_id: String

class BetaWebhookSessionThreadCreatedEventData { id, organization_id, session_thread_id, 2 more }

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.

type: :"session.thread_created"

workspace_id: String

class BetaWebhookSessionThreadIdledEventData { id, organization_id, session_thread_id, 2 more }

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.

type: :"session.thread_idled"

workspace_id: String

class BetaWebhookSessionThreadTerminatedEventData { id, organization_id, session_thread_id, 2 more }

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.

type: :"session.thread_terminated"

workspace_id: String

class BetaWebhookSessionUpdatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the session that triggered the event.

organization_id: String

type: :"session.updated"

workspace_id: String

class BetaWebhookVaultArchivedEventData { id, organization_id, type, workspace_id }

id: String

ID of the vault that triggered the event.

organization_id: String

type: :"vault.archived"

workspace_id: String

class BetaWebhookVaultCreatedEventData { id, organization_id, type, workspace_id }

id: String

ID of the vault that triggered the event.

organization_id: String

type: :"vault.created"

workspace_id: String

class BetaWebhookVaultCredentialArchivedEventData { id, organization_id, type, 2 more }

id: String

ID of the vault credential that triggered the event.

organization_id: String

type: :"vault_credential.archived"

vault_id: String

ID of the vault that owns this credential.

workspace_id: String

class BetaWebhookVaultCredentialCreatedEventData { id, organization_id, type, 2 more }

id: String

ID of the vault credential that triggered the event.

organization_id: String

type: :"vault_credential.created"

vault_id: String

ID of the vault that owns this credential.

workspace_id: String

class BetaWebhookVaultCredentialDeletedEventData { id, organization_id, type, 2 more }

id: String

ID of the vault credential that triggered the event.

organization_id: String

type: :"vault_credential.deleted"

vault_id: String

ID of the vault that owns this credential.

workspace_id: String

class BetaWebhookVaultCredentialRefreshFailedEventData { id, organization_id, type, 2 more }

id: String

ID of the vault credential that triggered the event.

organization_id: String

type: :"vault_credential.refresh_failed"

vault_id: String

ID of the vault that owns this credential.

workspace_id: String

class BetaWebhookVaultDeletedEventData { id, organization_id, type, workspace_id }

id: String

ID of the vault that triggered the event.

organization_id: String

type: :"vault.deleted"

workspace_id: String