GitHub: Agent automations schemas

← Agent automations operations · All schemas

Get an automation — response body — triggers

Field	Type	Presence	Description and constraints
$	object	Root	Trigger configuration for the automation. Additional keys: not allowed
automation_completed	Model	Optional	Expand Get an automation — response body — triggers automation completed
automation_failed	Model	Optional	Expand Get an automation — response body — triggers automation failed
code_scanning_alert	Model	Optional	Expand Get an automation — response body — triggers dependabot alert
dependabot_alert	Model	Optional	Expand Get an automation — response body — triggers dependabot alert
discussion_comment	Model	Optional	Expand Get an automation — response body — triggers discussion comment
discussion_opened	Model	Optional	Expand Get an automation — response body — triggers discussion opened
discussion_updated	Model	Optional	Expand Get an automation — response body — triggers discussion opened
interval	Model	Optional	Expand Get an automation — response body — triggers interval
issue_assigned	Model	Optional	Expand Get an automation — response body — triggers issue assigned
issue_closed	Model	Optional	Expand Get an automation — response body — triggers issue closed
issue_comment	Model	Optional	Expand Get an automation — response body — triggers issue comment
issue_labeled	Model	Optional	Expand Get an automation — response body — triggers issue labeled
issue_opened	Model	Optional	Expand Get an automation — response body — triggers issue closed
issue_reopened	Model	Optional	Expand Get an automation — response body — triggers issue closed
pull_request_assigned	Model	Optional	Expand Get an automation — response body — triggers pull request assigned
pull_request_closed	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_comment	Model	Optional	Expand Get an automation — response body — triggers pull request comment
pull_request_converted_to_draft	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_labeled	Model	Optional	Expand Get an automation — response body — triggers pull request labeled
pull_request_merge_conflict	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_merged	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_opened	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_ready_for_review	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_reopened	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_review_dismissed	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_review_requested	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_review_submitted	Model	Optional	Expand Get an automation — response body — triggers pull request review submitted
pull_request_review_thread_resolved	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_review_thread_unresolved	Model	Optional	Expand Get an automation — response body — triggers pull request closed
pull_request_synchronize	Model	Optional	Expand Get an automation — response body — triggers pull request closed
secret_scanning_alert	Model	Optional	Expand Get an automation — response body — triggers dependabot alert
sub_issue_added	Model	Optional	Expand Get an automation — response body — triggers issue closed
workflow_run	Model	Optional	Expand Get an automation — response body — triggers workflow run

Referenced models: Get an automation — response body — triggers automation completed, Get an automation — response body — triggers automation failed, Get an automation — response body — triggers dependabot alert, Get an automation — response body — triggers discussion comment, Get an automation — response body — triggers discussion opened, Get an automation — response body — triggers interval, Get an automation — response body — triggers issue assigned, Get an automation — response body — triggers issue closed, Get an automation — response body — triggers issue comment, Get an automation — response body — triggers issue labeled, Get an automation — response body — triggers pull request assigned, Get an automation — response body — triggers pull request closed, Get an automation — response body — triggers pull request comment, Get an automation — response body — triggers pull request labeled, Get an automation — response body — triggers pull request review submitted, Get an automation — response body — triggers workflow run

Get an automation — response body — triggers automation completed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
automation_ids	array	Required within parent	Upstream Automation IDs in the same repository. Maximum items: 3 Minimum items: 1 Unique items: true
automation_ids[]	string	Each item
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers automation failed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
automation_ids	array	Required within parent	Upstream Automation IDs in the same repository. An Automation cannot list itself, and a user-owned Automation can only be listed by its creator's user-owned Automations. Maximum items: 3 Minimum items: 1 Unique items: true
automation_ids[]	string	Each item
reasons	array	Optional	Failure reasons to match. Omit to match only reported failures. Maximum items: 3 Minimum items: 1 Unique items: true
reasons[]	string	Each item	Known values: reported, crashed, timed_out
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers dependabot alert

Field	Type	Presence	Description and constraints
$	object	Root	Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers discussion comment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
categories	array	Optional	Discussion category names matched case-insensitively. Minimum items: 1 Unique items: true
categories[]	string	Each item
comment_types	array	Optional	Top-level discussion comments and replies to match. Omit to match both. Maximum items: 2 Minimum items: 1 Unique items: true
comment_types[]	string	Each item	Known values: comment, reply
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers discussion opened

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
categories	array	Optional	Discussion category names matched case-insensitively. Minimum items: 1 Unique items: true
categories[]	string	Each item
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers interval

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
cadence	array	Required within parent	One or more schedules on which the Automation runs. Minimum items: 1 Unique items: true
cadence[]	string	Each item	Known values: hourly, daily, weekly
day_of_week	JSON	Optional
day_of_week (anyOf 1)	integer	Alternative	UTC weekday anchor for weekly schedules, where `0` is Sunday and `6` is Saturday. Omitted weekly values default to Monday (`1`). Maximum: 6 Minimum: 0
day_of_week (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hour_utc	JSON	Optional
hour_utc (anyOf 1)	integer	Alternative	UTC hour anchor (0 through 23) for daily and weekly schedules. Omitted daily and weekly values default to `0` (midnight UTC). Maximum: 23 Minimum: 0
hour_utc (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minute_utc	JSON	Optional
minute_utc (anyOf 1)	integer	Alternative	UTC minute anchor for daily and weekly schedules. Omitted daily and weekly values default to `0`. Must be omitted whenever `cadence` includes `hourly`. Known values: 0, 15, 30, 45 Default: 0
minute_utc (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
write_scope	string	Optional	Has no effect: scheduled runs can change any resource in the repository, and an organization or repository policy requiring trigger-scoped writes does not apply to them. Known values: trigger, repository

Get an automation — response body — triggers issue assigned

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
assignees	array	Optional	Affected assignee logins matched case-insensitively. Minimum items: 1 Unique items: true
assignees[]	string	Each item
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers issue closed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers issue comment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers issue labeled

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
labels	array	Optional	Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. Unique items: true
labels[]	string	Each item
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers pull request assigned

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
assignees	array	Optional	Affected assignee logins matched case-insensitively. Minimum items: 1 Unique items: true
assignees[]	string	Each item
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers pull request closed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers pull request comment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
comment_types	array	Required within parent	Pull request conversation and inline review comment types to match. Maximum items: 2 Minimum items: 1 Unique items: true
comment_types[]	string	Each item	Known values: timeline_comment, review_comment
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers pull request labeled

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
labels	array	Optional	Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. Unique items: true
labels[]	string	Each item
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers pull request review submitted

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
states	array	Required within parent	Submitted review states to match. Maximum items: 3 Minimum items: 1 Unique items: true
states[]	string	Each item	Known values: approved, changes_requested, commented
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Get an automation — response body — triggers workflow run

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
conclusions	array	Required within parent	Workflow conclusions to match. The current trigger supports failure. Maximum items: 1 Minimum items: 1
conclusions[]	string	Each item	Known values: failure
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
workflows	array	Required within parent	Workflow names matched against the name in each workflow YAML file. Minimum items: 1
workflows[]	string	Each item	Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. Known values: trigger, repository

Update an automation — request body — body triggers

Field	Type	Presence	Description and constraints
$	object	Root	Trigger configuration for the automation. Additional keys: not allowed
automation_completed	Model	Optional	Expand Update an automation — request body — body triggers automation completed
automation_failed	Model	Optional	Expand Update an automation — request body — body triggers automation failed
code_scanning_alert	Model	Optional	Expand Update an automation — request body — body triggers dependabot alert
dependabot_alert	Model	Optional	Expand Update an automation — request body — body triggers dependabot alert
discussion_comment	Model	Optional	Expand Update an automation — request body — body triggers discussion comment
discussion_opened	Model	Optional	Expand Update an automation — request body — body triggers discussion opened
discussion_updated	Model	Optional	Expand Update an automation — request body — body triggers discussion opened
interval	Model	Optional	Expand Update an automation — request body — body triggers interval
issue_assigned	Model	Optional	Expand Update an automation — request body — body triggers issue assigned
issue_closed	Model	Optional	Expand Update an automation — request body — body triggers issue closed
issue_comment	Model	Optional	Expand Update an automation — request body — body triggers issue comment
issue_labeled	Model	Optional	Expand Update an automation — request body — body triggers issue labeled
issue_opened	Model	Optional	Expand Update an automation — request body — body triggers issue closed
issue_reopened	Model	Optional	Expand Update an automation — request body — body triggers issue closed
pull_request_assigned	Model	Optional	Expand Update an automation — request body — body triggers pull request assigned
pull_request_closed	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_comment	Model	Optional	Expand Update an automation — request body — body triggers pull request comment
pull_request_converted_to_draft	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_labeled	Model	Optional	Expand Update an automation — request body — body triggers pull request labeled
pull_request_merge_conflict	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_merged	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_opened	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_ready_for_review	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_reopened	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_review_dismissed	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_review_requested	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_review_submitted	Model	Optional	Expand Update an automation — request body — body triggers pull request review submitted
pull_request_review_thread_resolved	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_review_thread_unresolved	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
pull_request_synchronize	Model	Optional	Expand Update an automation — request body — body triggers pull request closed
secret_scanning_alert	Model	Optional	Expand Update an automation — request body — body triggers dependabot alert
sub_issue_added	Model	Optional	Expand Update an automation — request body — body triggers issue closed
workflow_run	Model	Optional	Expand Update an automation — request body — body triggers workflow run

Referenced models: Update an automation — request body — body triggers automation completed, Update an automation — request body — body triggers automation failed, Update an automation — request body — body triggers dependabot alert, Update an automation — request body — body triggers discussion comment, Update an automation — request body — body triggers discussion opened, Update an automation — request body — body triggers interval, Update an automation — request body — body triggers issue assigned, Update an automation — request body — body triggers issue closed, Update an automation — request body — body triggers issue comment, Update an automation — request body — body triggers issue labeled, Update an automation — request body — body triggers pull request assigned, Update an automation — request body — body triggers pull request closed, Update an automation — request body — body triggers pull request comment, Update an automation — request body — body triggers pull request labeled, Update an automation — request body — body triggers pull request review submitted, Update an automation — request body — body triggers workflow run

Update an automation — request body — body triggers automation completed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
automation_ids	array	Required within parent	Upstream Automation IDs in the same repository. Maximum items: 3 Minimum items: 1 Unique items: true
automation_ids[]	string	Each item
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers automation failed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
automation_ids	array	Required within parent	Upstream Automation IDs in the same repository. An Automation cannot list itself, and a user-owned Automation can only be listed by its creator's user-owned Automations. Maximum items: 3 Minimum items: 1 Unique items: true
automation_ids[]	string	Each item
reasons	array	Optional	Failure reasons to match. Omit to match only reported failures. Maximum items: 3 Minimum items: 1 Unique items: true
reasons[]	string	Each item	One of: reported, crashed, timed_out
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers dependabot alert

Field	Type	Presence	Description and constraints
$	object	Root	Runs on the default branch when a security alert of this kind is created in the repository. These are system events without an issue, pull request, or human actor, and cannot be run manually. Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers discussion comment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
categories	array	Optional	Discussion category names matched case-insensitively. Minimum items: 1 Unique items: true
categories[]	string	Each item
comment_types	array	Optional	Top-level discussion comments and replies to match. Omit to match both. Maximum items: 2 Minimum items: 1 Unique items: true
comment_types[]	string	Each item	One of: comment, reply
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers discussion opened

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
categories	array	Optional	Discussion category names matched case-insensitively. Minimum items: 1 Unique items: true
categories[]	string	Each item
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers interval

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
cadence	array	Required within parent	One or more schedules on which the Automation runs. Minimum items: 1 Unique items: true
cadence[]	string	Each item	One of: hourly, daily, weekly
day_of_week	integer	Optional	UTC weekday anchor for weekly schedules, where `0` is Sunday and `6` is Saturday. Omitted weekly values default to Monday (`1`). Maximum: 6 Minimum: 0
hour_utc	integer	Optional	UTC hour anchor (0 through 23) for daily and weekly schedules. Omitted daily and weekly values default to `0` (midnight UTC). Maximum: 23 Minimum: 0
minute_utc	integer	Optional	UTC minute anchor for daily and weekly schedules. Omitted daily and weekly values default to `0`. Must be omitted whenever `cadence` includes `hourly`. Default: 0 One of: 0, 15, 30, 45
write_scope	string	Optional	Has no effect: scheduled runs can change any resource in the repository, and an organization or repository policy requiring trigger-scoped writes does not apply to them. One of: trigger, repository

Update an automation — request body — body triggers issue assigned

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
assignees	array	Optional	Affected assignee logins matched case-insensitively. Minimum items: 1 Unique items: true
assignees[]	string	Each item
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers issue closed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers issue comment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers issue labeled

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
labels	array	Optional	Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. Unique items: true
labels[]	string	Each item
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers pull request assigned

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
assignees	array	Optional	Affected assignee logins matched case-insensitively. Minimum items: 1 Unique items: true
assignees[]	string	Each item
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers pull request closed

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers pull request comment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
body_substring	string	Optional	A case-insensitive substring matched against the event body.
comment_types	array	Required within parent	Pull request conversation and inline review comment types to match. Maximum items: 2 Minimum items: 1 Unique items: true
comment_types[]	string	Each item	One of: timeline_comment, review_comment
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers pull request labeled

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
labels	array	Optional	Label names matched case-insensitively against the label added by the event. Omit or use an empty array to match every added label. Unique items: true
labels[]	string	Each item
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers pull request review submitted

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
paths	array	Optional	Gitignore-style changed-file path globs. Minimum items: 1
paths[]	string	Each item	Minimum length: 1
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
states	array	Required within parent	Submitted review states to match. Maximum items: 3 Minimum items: 1 Unique items: true
states[]	string	Each item	One of: approved, changes_requested, commented
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository

Update an automation — request body — body triggers workflow run

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
allow_copilot_triggers	boolean	Optional	When true, events Copilot creates, including from other automations and Copilot sessions, can start this automation through this trigger. Defaults to false. The Copilot coding agent app cannot turn it on: creating a trigger with true, or changing it from false to true, returns 422.
conclusions	array	Required within parent	Workflow conclusions to match. The current trigger supports failure. Maximum items: 1 Minimum items: 1
conclusions[]	string	Each item	One of: failure
query	string	Optional	A GitHub issue or pull request search query. Minimum length: 1
workflows	array	Required within parent	Workflow names matched against the name in each workflow YAML file. Minimum items: 1
workflows[]	string	Each item	Minimum length: 1
write_scope	string	Optional	Override the Automation `write_scope` for runs started by this trigger. If omitted, the automation's `write_scope` is used. Organization or repository policy may restrict the effective scope to `trigger`. Explicitly setting `repository` on create or edit returns 422 when policy validation is enabled and that policy applies. One of: trigger, repository