Notification Webhook Schema

AgentHealthEvent

AgentHealthEvent contains metadata for an agent health event.

Field	Type	Description
instance_id	string	The instance ID.
instance_name	string	The instance name.
cluster_id	string	The cluster ID.
cluster_name	string	The cluster name.
status	string	The agent status: "connected" or "disconnected".
timestamp	google.protobuf.Timestamp	The time the status change occurred.
kargo	bool	Whether this is a Kargo agent (true) or Argo CD cluster (false).

AuditEvent

AuditEvent contains metadata for an audit event.

Field	Type	Description
timestamp	string	The time the event was triggered.
action	string	The action that was performed.
actor	AuditEvent.EventAuditActor	The actor that triggered the event.
object	AuditEvent.EventAuditObject	The object that was acted upon.
details	AuditEvent.EventAuditDetails	The details of the event.

AuditEvent.EventAuditActor

Field	Type	Description
type	string	The type of actor.
id	string	The ID of the actor.
ip	string	The IP address of the actor.
origin	string	Identifies how the action reached Akuity. "mcp" means it came through Akuity's MCP endpoint. Empty when unavailable.

AuditEvent.EventAuditDetails

Field	Type	Description
message	string	The message associated with the event.
patch	string	The patch associated with the event.
action_type	string	The action type.

AuditEvent.EventAuditObject

Field	Type	Description
type	string	The type of object. E.g. "team_member", "team", "custom_role", "kargo_instance", etc.
id	AuditEvent.EventAuditObject.EventAuditObjId	The ID of the object.
parent_id	AuditEvent.EventAuditObject.EventAuditParentId	The parent ID of the object.

AuditEvent.EventAuditObject.EventAuditObjId

Field	Type	Description
name	string	The name of the object.
kind	string	The kind of object.
group	string	The group of the object.
namespace	string	The namespace of a namespaced object.

AuditEvent.EventAuditObject.EventAuditParentId

Field	Type	Description
name	string	The name of the parent.
parent_name	string	The name of the parent object's parent (if present).
application_name	string	The name of the application.
kargo_project_name	string	The Kargo project the object belongs to.

CnameAlertEvent

CnameAlertEvent contains metadata for a CNAME alert event.

Field	Type	Description
instance_id	string	The instance ID.
instance_name	string	The instance name.
fqdn	string	The FQDN that is not configured.
message	string	The alert message.
kargo	bool	Whether this is a Kargo instance (true) or ArgoCD instance (false).

FreeTrialExpiringEvent

FreeTrialExpiringEvent contains metadata for a free trial expiring event.

Field	Type	Description
days	int32	The number of days until the free trial expires.

NewProductVersionEvent

NewProductVersionEvent contains metadata for a new product version event.

Field	Type	Description
version	string	The new product version.
product	string	The product associated with the new version. E.g. "ArgoCD", "Kargo", "Akuity Agent".

PingEvent

PingEvent contains metadata for a ping event.

Field	Type	Description
notification_config_id	string	NotificationConfigID is the organization notification config ID that triggered the ping

UsageUpdateEvent

Field	Type	Description
product	string	The product associated with the usage update. E.g. "ArgoCD", "Kargo", "Akuity Agent".
usage_type	string	The type of usage. E.g. "applications", "projects".
usage_threshold	double	The usage threshold.
max_limit	int64	The maximum limit.
usage	int64	The current usage.

WebhookEventPayload

WebhookEventPayload is the payload sent to the webhook endpoint.

Field	Type	Description
event_time	google.protobuf.Timestamp	The time the event was triggered.
event_type	WebhookEventType	The type of event.
organization_id	string	The organization ID.
event_id	string	The event ID.
ping_event	PingEvent	Metadata for a ping event.
usage_event	UsageUpdateEvent	Metadata for a usage update event.
audit_event	AuditEvent	Metadata for an audit event.
agent_health_event	AgentHealthEvent	Metadata for an agent health event.
cname_alert_event	CnameAlertEvent	Metadata for a CNAME alert event.
new_product_version_event	NewProductVersionEvent	Metadata for a new product version event.
free_trial_expiring_event	FreeTrialExpiringEvent	Metadata for a free trial expiring event.