GitHub: Agent automations schemas
36 GitHub schemas with complete fields and constraints.
← Agent automations operations · All schemas
Get an automation revision — response body — snapshot
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The automation's public detail representation after the change, including its enabled state at configuration-save time, not its current lifecycle state. Legacy deleted revisions are identified by `change_type`. Additional keys: not allowed |
created_at | string | Required within parent | When the automation was created. Format: date-time |
created_by | object | Required within parent | A GitHub user |
created_by.id | JSON | Optional | |
created_by.id (anyOf 1) | integer | Alternative | The unique identifier of the user Format: int64 |
created_by.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
enabled | boolean | Optional | Whether the automation was enabled when this configuration was saved. |
id | string | Required within parent | The unique identifier of the automation. |
model | string | Optional | The model override for sessions triggered by this automation. Absent when the platform selects the model. |
name | string | Required within parent | The name of the automation. |
prompt | string | Required within parent | The prompt for the automation. |
reasoning_effort | string | Optional | The reasoning effort override for sessions triggered by this automation. Absent when the model's default is used. |
require_actor_write_permission | boolean | Optional | When true, event-triggered runs require the event actor to have repo write permission, even when the org's allow_read_access_triggers policy is enabled. Does not apply to interval-scheduled runs, which always run as the automation owner. Default: false |
tools | array | Optional | The tools available to the automation. |
tools[] | string | Each item | |
triggers | Model | Optional | Expand Get an automation — response body — triggers |
type | string | Optional | The type of automation. `personal` keeps it private to its creator and its runs act as that user. `shared` makes it belong to the repository, visible to anyone with read access to the repository, and its runs act as the Copilot app rather than as a person. Known values: personal, shared Read only: true |
updated_at | string | Required within parent | When the automation was last updated. Format: date-time |
Referenced models: Get an automation — response body — triggers
Get an automation — response body — triggers
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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 |
List revisions for an automation — response body — revisions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An immutable snapshot of an automation's public definition after one configuration save, with the attribution needed to understand who made the change. Legacy history may also contain lifecycle-only snapshots. |
automation_id | string | Required within parent | The automation this revision belongs to. |
change_type | string | Required within parent | The kind of change recorded by the revision. Known values: created, edited, enabled, disabled, deleted, rolled_back, unknown |
changed_at | string | Required within parent | When the change was applied. Format: date-time |
creator | JSON | Optional | The automation's original creator. Omitted when not recorded. |
creator (allOf 1) | object | All variants apply | A GitHub user |
creator (allOf 1).id | JSON | Optional | |
creator (allOf 1).id (anyOf 1) | integer | Alternative | The unique identifier of the user Format: int64 |
creator (allOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
editor | JSON | Optional | The person who made this change. Omitted for system changes and legacy records. |
editor (allOf 1) | object | All variants apply | A GitHub user |
editor (allOf 1).id | JSON | Optional | |
editor (allOf 1).id (anyOf 1) | integer | Alternative | The unique identifier of the user Format: int64 |
editor (allOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
editor_type | string | Optional | The kind of actor that made the change. Known values: user, system, unknown |
id | string | Required within parent | The unique identifier of this revision. |
restored_from_revision_id | string | Optional | The revision a rollback restored. Present only when `change_type` is `rolled_back`. |
revision_number | JSON | Required within parent | |
revision_number (anyOf 1) | integer | Alternative | Position of this revision in the automation's history, starting at 1. Format: int64 |
revision_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
snapshot | Model | Optional | Expand Get an automation revision — response body — snapshot |
Referenced models: Get an automation revision — response body — snapshot
Update an automation — request body — body triggers
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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 | Sets the write scope for this trigger's runs. Omit to inherit the automation's effective scope (default `trigger`). 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 |