Skip to main content
GET
Get automation event schemas

Permissions

Requires a service user or personal access token with the ViewOrgAutomations permission at the organization level.

Usage

Call this endpoint before building automations: it returns every supported trigger event type (keyed by source, then event name) with its payload fields, the operators its conditions support, and the valid replies verbs, so you can construct valid triggers for the create and update endpoints. Sources that are not enabled for the organization are omitted.

Authorizations

Authorization
string
header
required

Service User credential (prefix: cog_)

Path Parameters

org_id
string
required

Organization ID (prefix: org-)

Example:

"org-abc123def456"

Query Parameters

security_profile_id
string | null

Resolve default_net_policy and security_profile for a create that sets security_profile.profile_id to this profile. Requires the security-profile management permission.

Response

Successful Response

default_net_policy
AutomationNetPolicy · object | null
required

Network policy clients should start new automations from: the deployment's Git Manager-only policy (add only the destinations the task requires), or null when the governing security profile (see security_profile) has a network policy. In that case sessions use the profile's policy; omit session_settings.net_policy unless the task must restrict further.

sources
Sources · object
required

Event source → event name → schema.

update_semantics
string
required

PATCH semantics active for this organization: 'replace_groups' (a config group present in the request replaces the stored group wholesale) or 'merge_patch' (RFC 7396 for objects: omitted members of a present group keep their stored values, explicit nulls clear; list membership still replaces wholesale — deletion is resending the list without the element — but each sent element merges onto the stored element of the same type when that type appears exactly once on both sides; repeated types must be restated fully). Open enum — clients must tolerate new values.

security_profile
AutomationSchemasSecurityProfile · object | null

Security profile governing this organization's automation sessions, or null when none applies.