Webhooks
Models
class BetaWebhookAgentArchivedEventData { Type = "agent.archived"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookAgentArchivedEventData { Type = "agent.archived"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "agent.archived"
required string ID
ID of the agent that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookAgentCreatedEventData { Type = "agent.created"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookAgentCreatedEventData { Type = "agent.created"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "agent.created"
required string ID
ID of the agent that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookAgentDeletedEventData { Type = "agent.deleted"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookAgentDeletedEventData { Type = "agent.deleted"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "agent.deleted"
required string ID
ID of the agent that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookAgentUpdatedEventData { Type = "agent.updated"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookAgentUpdatedEventData { Type = "agent.updated"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "agent.updated"
required string ID
ID of the agent that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentArchivedEventData { Type = "deployment.archived"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentArchivedEventData { Type = "deployment.archived"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment.archived"
required string ID
ID of the deployment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentCreatedEventData { Type = "deployment.created"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentCreatedEventData { Type = "deployment.created"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment.created"
required string ID
ID of the deployment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentDeletedEventData { Type = "deployment.deleted"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentDeletedEventData { Type = "deployment.deleted"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment.deleted"
required string ID
ID of the deployment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentPausedEventData { Type = "deployment.paused"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentPausedEventData { Type = "deployment.paused"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment.paused"
required string ID
ID of the deployment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentRunFailedEventData { Type = "deployment_run.failed"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentRunFailedEventData { Type = "deployment_run.failed"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment_run.failed"
required string ID
ID of the deployment run that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentRunStartedEventData { Type = "deployment_run.started"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentRunStartedEventData { Type = "deployment_run.started"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment_run.started"
required string ID
ID of the deployment run that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentRunSucceededEventData { Type = "deployment_run.succeeded"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentRunSucceededEventData { Type = "deployment_run.succeeded"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment_run.succeeded"
required string ID
ID of the deployment run that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentUnpausedEventData { Type = "deployment.unpaused"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentUnpausedEventData { Type = "deployment.unpaused"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment.unpaused"
required string ID
ID of the deployment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookDeploymentUpdatedEventData { Type = "deployment.updated"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookDeploymentUpdatedEventData { Type = "deployment.updated"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "deployment.updated"
required string ID
ID of the deployment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookEnvironmentArchivedEventData { Type = "environment.archived"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookEnvironmentArchivedEventData { Type = "environment.archived"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "environment.archived"
required string ID
ID of the environment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookEnvironmentCreatedEventData { Type = "environment.created"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookEnvironmentCreatedEventData { Type = "environment.created"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "environment.created"
required string ID
ID of the environment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookEnvironmentDeletedEventData { Type = "environment.deleted"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookEnvironmentDeletedEventData { Type = "environment.deleted"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "environment.deleted"
required string ID
ID of the environment that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookEnvironmentUpdatedEventData { Type = "environment.updated"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookEnvironmentUpdatedEventData { Type = "environment.updated"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "environment.updated"
required string ID
ID of the environment that triggered the event.
required string OrganizationID
required string WorkspaceID
class UnwrapWebhookEvent { Type = "event"; ID; CreatedAt; Data; }
class UnwrapWebhookEvent { Type = "event"; ID; CreatedAt; Data; }
JsonElement Type = "event"
Object type. Always event for webhook payloads.
required string ID
Unique event identifier for idempotency.
required DateTimeOffset CreatedAtRFC 3339 timestamp when the event occurred.
required DateTimeOffset CreatedAt
RFC 3339 timestamp when the event occurred.
formatdate-time
required BetaWebhookEventData Data
required BetaWebhookEventData Data
One of the following:
class BetaWebhookEventData: union
class BetaWebhookEventData: union
class BetaWebhookMemoryStoreArchivedEventData { Type = "memory_store.archived"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookMemoryStoreArchivedEventData { Type = "memory_store.archived"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "memory_store.archived"
required string ID
ID of the memory store that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookMemoryStoreCreatedEventData { Type = "memory_store.created"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookMemoryStoreCreatedEventData { Type = "memory_store.created"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "memory_store.created"
required string ID
ID of the memory store that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookMemoryStoreDeletedEventData { Type = "memory_store.deleted"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookMemoryStoreDeletedEventData { Type = "memory_store.deleted"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "memory_store.deleted"
required string ID
ID of the memory store that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionArchivedEventData { Type = "session.archived"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionArchivedEventData { Type = "session.archived"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.archived"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionBudgetReachedEventData { Type = "session.budget_reached"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionBudgetReachedEventData { Type = "session.budget_reached"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.budget_reached"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionCreatedEventData { Type = "session.created"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionCreatedEventData { Type = "session.created"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.created"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionDeletedEventData { Type = "session.deleted"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionDeletedEventData { Type = "session.deleted"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.deleted"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionIdledEventData { Type = "session.idled"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionIdledEventData { Type = "session.idled"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.idled"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionOutcomeEvaluationEndedEventData { Type = "session.outcome_evaluation_ended"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionOutcomeEvaluationEndedEventData { Type = "session.outcome_evaluation_ended"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.outcome_evaluation_ended"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionPendingEventData { Type = "session.pending"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionPendingEventData { Type = "session.pending"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.pending"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionRequiresActionEventData { Type = "session.requires_action"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionRequiresActionEventData { Type = "session.requires_action"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.requires_action"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionRunningEventData { Type = "session.running"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionRunningEventData { Type = "session.running"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.running"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionStatusIdledEventData { Type = "session.status_idled"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionStatusIdledEventData { Type = "session.status_idled"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.status_idled"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionStatusRescheduledEventData { Type = "session.status_rescheduled"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionStatusRescheduledEventData { Type = "session.status_rescheduled"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.status_rescheduled"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionStatusRunStartedEventData { Type = "session.status_run_started"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionStatusRunStartedEventData { Type = "session.status_run_started"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.status_run_started"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionStatusTerminatedEventData { Type = "session.status_terminated"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionStatusTerminatedEventData { Type = "session.status_terminated"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.status_terminated"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookSessionThreadCreatedEventData { Type = "session.thread_created"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookSessionThreadCreatedEventData { Type = "session.thread_created"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "session.thread_created"
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.
required string WorkspaceID
class BetaWebhookSessionThreadIdledEventData { Type = "session.thread_idled"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookSessionThreadIdledEventData { Type = "session.thread_idled"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "session.thread_idled"
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.
required string WorkspaceID
class BetaWebhookSessionThreadTerminatedEventData { Type = "session.thread_terminated"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookSessionThreadTerminatedEventData { Type = "session.thread_terminated"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "session.thread_terminated"
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.
required string WorkspaceID
class BetaWebhookSessionUpdatedEventData { Type = "session.updated"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookSessionUpdatedEventData { Type = "session.updated"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "session.updated"
required string ID
ID of the session that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookVaultArchivedEventData { Type = "vault.archived"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookVaultArchivedEventData { Type = "vault.archived"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "vault.archived"
required string ID
ID of the vault that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookVaultCreatedEventData { Type = "vault.created"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookVaultCreatedEventData { Type = "vault.created"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "vault.created"
required string ID
ID of the vault that triggered the event.
required string OrganizationID
required string WorkspaceID
class BetaWebhookVaultCredentialArchivedEventData { Type = "vault_credential.archived"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookVaultCredentialArchivedEventData { Type = "vault_credential.archived"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "vault_credential.archived"
required string ID
ID of the vault credential that triggered the event.
required string OrganizationID
required string VaultID
ID of the vault that owns this credential.
required string WorkspaceID
class BetaWebhookVaultCredentialCreatedEventData { Type = "vault_credential.created"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookVaultCredentialCreatedEventData { Type = "vault_credential.created"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "vault_credential.created"
required string ID
ID of the vault credential that triggered the event.
required string OrganizationID
required string VaultID
ID of the vault that owns this credential.
required string WorkspaceID
class BetaWebhookVaultCredentialDeletedEventData { Type = "vault_credential.deleted"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookVaultCredentialDeletedEventData { Type = "vault_credential.deleted"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "vault_credential.deleted"
required string ID
ID of the vault credential that triggered the event.
required string OrganizationID
required string VaultID
ID of the vault that owns this credential.
required string WorkspaceID
class BetaWebhookVaultCredentialRefreshFailedEventData { Type = "vault_credential.refresh_failed"; ID; OrganizationID; /* 2 more */ }
class BetaWebhookVaultCredentialRefreshFailedEventData { Type = "vault_credential.refresh_failed"; ID; OrganizationID; /* 2 more */ }
JsonElement Type = "vault_credential.refresh_failed"
required string ID
ID of the vault credential that triggered the event.
required string OrganizationID
required string VaultID
ID of the vault that owns this credential.
required string WorkspaceID
class BetaWebhookVaultDeletedEventData { Type = "vault.deleted"; ID; OrganizationID; WorkspaceID; }
class BetaWebhookVaultDeletedEventData { Type = "vault.deleted"; ID; OrganizationID; WorkspaceID; }
JsonElement Type = "vault.deleted"
required string ID
ID of the vault that triggered the event.
required string OrganizationID
required string WorkspaceID