GIgithub
agent-automations

List available automation triggers for a repository

Changed on

[!NOTE] This endpoint is in public preview and is subject to change.

Lists available triggers for automations in a repository.

Each available trigger includes a title and description that can be presented in user interfaces, plus a machine-readable schema of filters supported by the trigger.

GitHub App installation access tokens can list available automation triggers. The installation must belong to the repository owner and the token must have "Agent tasks" repository permissions (read).

To call this endpoint, OAuth app tokens and personal access tokens (classic) need:

  • the repo scope for private or internal repositories
  • the repo scope or public_repo scope for public repositories

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

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

The fine-grained token must have the following permission set:

  • "Agent tasks" repository permissions (read)
get/agents/repos/{owner}/{repo}/automations/available-triggers

Request

  • Base URL
    https://api.github.com
  • URL
    https://api.github.com/agents/repos/{owner}/{repo}/automations/available-triggers
  • Auth
    none declared

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository. The name is not case sensitive.

Response

Available automation triggers retrieved successfully

idstring required

The unique identifier of the trigger.

titlestring required

The human-readable name of the trigger.

descriptionstring required

A short description of when the trigger fires.

Changes