GET/agents/automations/available-triggers

List available automation triggers

Returns the triggers available to the authenticated caller, including machine-readable schemas for their configurable fields.

Fine-grained access tokens for "List available automation triggers"

This endpoint works with the following fine-grained token types:

This endpoint does not require repository permissions.

GitHub App installation access tokens are not supported for this endpoint.

2 status codes

200Available automation triggers retrieved successfully

idstringrequired

The stable public trigger identifier.

titlestringrequired

The human-readable trigger title.

descriptionstringrequired

A short description of when the trigger fires.

fieldsarray<object>required

The trigger-specific public configuration fields.

supports_run_nowbooleanoptional

Whether this trigger supports event-specific Run now simulation. Omit to indicate support.

401Authentication required

messagestringrequired

Summary message (e.g. "Validation Failed", "Not Found")

errorsarray<object>optional

List of validation errors (present only for 422 responses)

documentation_urlstringrequired

URL to relevant API documentation

Error handling

A 401 is returned: Authentication required.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.availableTriggers.list();

[
  {
    "id": "issue_opened",
    "title": "Issue opened",
    "description": "Runs when an issue is opened.",
    "fields": [
      {
        "id": "query",
        "label": "Issue query",
        "required": false,
        "description": "Only run for issues matching this query, using [issue search syntax](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests).",
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      {
        "id": "write_scope",
        "label": "Write scope",
        "required": false,
        "description": "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`.",
        "schema": {
          "type": "string",
          "enum": [
            "trigger",
            "repository"
          ]
        }
      }
    ]
  },
  {
    "id": "interval",
    "title": "Schedule",
    "description": "Runs on a schedule.",
    "fields": [
      {
        "id": "cadence",
        "label": "Cadence",
        "required": true,
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "hourly",
              "daily",
              "weekly"
            ]
          },
          "minItems": 1,
          "uniqueItems": true
        }
      },
      {
        "id": "hour_utc",
        "label": "UTC hour",
        "required": false,
        "description": "UTC hour anchor (0 through 23) for daily and weekly schedules. Omitted daily and weekly values default to `0` (midnight UTC).",
        "schema": {
          "type": "integer",
          "minimum": 0,
          "maximum": 23
        }
      },
      {
        "id": "day_of_week",
        "label": "Day of week",
        "required": false,
        "description": "UTC weekday anchor for weekly schedules, where `0` is Sunday and `6` is Saturday. Omitted weekly values default to Monday (`1`).",
        "schema": {
          "type": "integer",
          "minimum": 0,
          "maximum": 6
        }
      },
      {
        "id": "minute_utc",
        "label": "UTC minute",
        "required": false,
        "description": "UTC minute anchor for daily and weekly schedules. Omitted daily and weekly values default to `0`. Must be omitted whenever `cadence` includes `hourly`.",
        "schema": {
          "type": "integer",
          "enum": [
            0,
            15,
            30,
            45
          ]
        }
      },
      {
        "id": "write_scope",
        "label": "Write scope",
        "required": false,
        "description": "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`.",
        "schema": {
          "type": "string",
          "enum": [
            "trigger",
            "repository"
          ]
        }
      }
    ]
  },
  {
    "id": "pull_request_opened",
    "title": "Pull request opened",
    "description": "Runs when a pull request is opened.",
    "fields": [
      {
        "id": "query",
        "label": "Pull request query",
        "required": false,
        "description": "Only run for pull requests matching this query, using [issue search syntax](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests).",
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      {
        "id": "paths",
        "label": "Path filter",
        "required": false,
        "description": "Only run for pull requests where the changed files match one or more of these [gitignore-style path globs](https://git-scm.com/docs/gitignore#_pattern_format).",
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "minItems": 1
        }
      },
      {
        "id": "write_scope",
        "label": "Write scope",
        "required": false,
        "description": "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`.",
        "schema": {
          "type": "string",
          "enum": [
            "trigger",
            "repository"
          ]
        }
      }
    ]
  },
  {
    "id": "pull_request_review_submitted",
    "title": "Pull request review submitted",
    "description": "Runs when a pull request review is submitted.",
    "fields": [
      {
        "id": "query",
        "label": "Pull request query",
        "required": false,
        "description": "Only run for pull requests matching this query, using [issue search syntax](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests).",
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      {
        "id": "paths",
        "label": "Path filter",
        "required": false,
        "description": "Only run for pull requests where the changed files match one or more of these [gitignore-style path globs](https://git-scm.com/docs/gitignore#_pattern_format).",
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "minItems": 1
        }
      },
      {
        "id": "states",
        "label": "Review state",
        "required": true,
        "description": "Only run for submitted reviews with one of these states.",
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "approved",
              "changes_requested",
              "commented"
            ]
          },
          "minItems": 1,
          "maxItems": 3,
          "uniqueItems": true
        }
      },
      {
        "id": "write_scope",
        "label": "Write scope",
        "required": false,
        "description": "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`.",
        "schema": {
          "type": "string",
          "enum": [
            "trigger",
            "repository"
          ]
        }
      }
    ]
  },
  {
    "id": "automation_completed",
    "title": "Automation completed",
    "description": "Runs when an upstream Automation completes successfully.",
    "fields": [
      {
        "id": "automation_ids",
        "label": "Upstream Automations",
        "required": true,
        "description": "Only run after one of these Automations completes successfully in this repository.",
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "maxItems": 3,
          "uniqueItems": true
        }
      },
      {
        "id": "write_scope",
        "label": "Write scope",
        "required": false,
        "description": "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`.",
        "schema": {
          "type": "string",
          "enum": [
            "trigger",
            "repository"
          ]
        }
      }
    ],
    "supports_run_now": false
  }
]

Response

Errors