GitHub: List available automation triggers for a repository

← Agent automations operations · Get started

Operation github.agent_automations_list_available_repo_automation_triggers

Provider route: GET /agents/repos/{owner}/{repo}/automations/available-triggers. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["agentAutomations"]["agentAutomationsListAvailableRepoAutomationTriggers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.agentAutomations.agentAutomationsListAvailableRepoAutomationTriggers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.agent_automations.agent_automations_list_available_repo_automation_triggers(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	object	Each item	An available trigger for automations Additional keys: not allowed
$[].description	string	Required within parent	A short description of when the trigger fires.
$[].fields	array	Required within parent	The fields that can be specified to configure this trigger.
$[].fields[]	object	Each item	A filter that can be configured when using a trigger in an automation. Additional keys: not allowed
$[].fields[].description	string	Optional	The human-readable description of the field.
$[].fields[].id	string	Required within parent	The stable identifier of the field.
$[].fields[].label	string	Required within parent	The human-readable name of the field.
$[].fields[].required	boolean	Required within parent	Whether the field must be provided.
$[].fields[].schema	JSON	Required within parent	A JSON Schema fragment describing the expected structure of the field value.
$[].fields[].schema (anyOf 1)	object	Alternative	Additional keys: not allowed
$[].fields[].schema (anyOf 1).enum	array	Optional	The allowed string values.
$[].fields[].schema (anyOf 1).enum[]	string	Each item
$[].fields[].schema (anyOf 1).minLength	JSON	Optional
$[].fields[].schema (anyOf 1).minLength (anyOf 1)	integer	Alternative	The minimum accepted string length. Minimum: 0
$[].fields[].schema (anyOf 1).minLength (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 1).type	string	Required within parent	Known values: string
$[].fields[].schema (anyOf 2)	object	Alternative	Additional keys: not allowed
$[].fields[].schema (anyOf 2).items	object	Required within parent	Additional keys: not allowed
$[].fields[].schema (anyOf 2).items.enum	array	Optional	The allowed string item values.
$[].fields[].schema (anyOf 2).items.enum[]	string	Each item
$[].fields[].schema (anyOf 2).items.minLength	JSON	Optional
$[].fields[].schema (anyOf 2).items.minLength (anyOf 1)	integer	Alternative	The minimum accepted string item length. Minimum: 0
$[].fields[].schema (anyOf 2).items.minLength (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 2).items.type	string	Required within parent	Known values: string
$[].fields[].schema (anyOf 2).maxItems	JSON	Optional
$[].fields[].schema (anyOf 2).maxItems (anyOf 1)	integer	Alternative	The maximum accepted number of array items. Minimum: 0
$[].fields[].schema (anyOf 2).maxItems (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 2).minItems	JSON	Optional
$[].fields[].schema (anyOf 2).minItems (anyOf 1)	integer	Alternative	The minimum accepted number of array items. Minimum: 0
$[].fields[].schema (anyOf 2).minItems (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 2).type	string	Required within parent	Known values: array
$[].fields[].schema (anyOf 2).uniqueItems	boolean	Optional	Whether duplicate array items are rejected.
$[].fields[].schema (anyOf 3)	object	Alternative	Additional keys: not allowed
$[].fields[].schema (anyOf 3).enum	array	Optional	The allowed integer values.
$[].fields[].schema (anyOf 3).enum[]	JSON	Each item
$[].fields[].schema (anyOf 3).enum[] (anyOf 1)	integer	Alternative
$[].fields[].schema (anyOf 3).enum[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 3).maximum	JSON	Optional
$[].fields[].schema (anyOf 3).maximum (anyOf 1)	integer	Alternative	The maximum accepted integer value.
$[].fields[].schema (anyOf 3).maximum (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 3).minimum	JSON	Optional
$[].fields[].schema (anyOf 3).minimum (anyOf 1)	integer	Alternative	The minimum accepted integer value.
$[].fields[].schema (anyOf 3).minimum (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].fields[].schema (anyOf 3).type	string	Required within parent	Known values: integer
$[].id	string	Required within parent	The unique identifier of the trigger.
$[].title	string	Required within parent	The human-readable name of the trigger.

Policy, approvals and errors

SDK function policy ID: github.agent_automations_list_available_repo_automation_triggers. Catalog operation: agent-automations/list-available-repo-automation-triggers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source