Notification Webhook Schema

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.

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.

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.

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.