GitHub: Get an issue event

GitHub issues.issuesGetEvent: arguments, response, policy and SDK examples.

Operation github.issues_get_event

Provider route: GET /repos/{owner}/{repo}/issues/events/{event_id}. 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["issues"]["issuesGetEvent"]>[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.issues.issuesGetEvent(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.issues.issues_get_event(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
`path.event_id`	integer	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
`$`	Model	Root	Expand Get an issue event — response body

Referenced models: Get an issue event — response body

Schemas

31 more schemas are linked from the tables above, on the schema pages.

Get an issue event — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Issue Event
`actor`	Model	Required within parent	Expand Get an issue — response body — user
`assignee`	Model	Optional	Expand Get an issue — response body — user
`assigner`	Model	Optional	Expand Get an issue — response body — user
`author_association`	string	Optional	How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER
`blocked_by`	Model	Optional	Expand Get an issue event — response body — blocking
`blocking`	Model	Optional	Expand Get an issue event — response body — blocking
`commit_id`	JSON	Required within parent
`commit_id (anyOf 1)`	string	Alternative
`commit_id (anyOf 2)`	null	Alternative
`commit_url`	JSON	Required within parent
`commit_url (anyOf 1)`	string	Alternative
`commit_url (anyOf 2)`	null	Alternative
`created_at`	string	Required within parent	Format: date-time
`dismissed_review`	Model	Optional	Expand Get an issue event — response body — dismissed review
`event`	string	Required within parent
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`intent`	Model	Optional	Expand Get an issue event — response body — intent
`issue`	Model	Optional	Expand Get an issue event — response body — issue
`issue_type`	Model	Optional	Expand Get an issue event — response body — issue type
`label`	Model	Optional	Expand Get an issue event — response body — label
`lock_reason`	JSON	Optional
`lock_reason (anyOf 1)`	string	Alternative
`lock_reason (anyOf 2)`	null	Alternative
`milestone`	Model	Optional	Expand Get an issue event — response body — milestone
`node_id`	string	Required within parent
`parent_issue`	Model	Optional	Expand Get an issue event — response body — blocking
`performed_via_github_app`	Model	Optional	Expand Get an app — response body
`prev_issue_type`	Model	Optional	Expand Get an issue event — response body — issue type
`project_card`	Model	Optional	Expand Get an issue event — response body — project card
`rename`	Model	Optional	Expand Get an issue event — response body — rename
`requested_reviewer`	Model	Optional	Expand Get an issue — response body — user
`requested_team`	Model	Optional	Expand List teams — response body — item
`review_requester`	Model	Optional	Expand Get an issue — response body — user
`sub_issue`	Model	Optional	Expand Get an issue event — response body — blocking
`url`	string	Required within parent	Format: uri

Get an app — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
`$ (anyOf 1).client_id`	string	Optional
`$ (anyOf 1).created_at`	string	Required within parent	Format: date-time
`$ (anyOf 1).description`	JSON	Required within parent
`$ (anyOf 1).description (anyOf 1)`	string	Alternative
`$ (anyOf 1).description (anyOf 2)`	null	Alternative
`$ (anyOf 1).events`	array	Required within parent	The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
`$ (anyOf 1).events[]`	string	Each item
`$ (anyOf 1).external_url`	string	Required within parent	Format: uri
`$ (anyOf 1).html_url`	string	Required within parent	Format: uri
`$ (anyOf 1).id`	JSON	Required within parent
`$ (anyOf 1).id (anyOf 1)`	integer	Alternative	Unique identifier of the GitHub app
`$ (anyOf 1).id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).installations_count`	JSON	Optional
`$ (anyOf 1).installations_count (anyOf 1)`	integer	Alternative	The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
`$ (anyOf 1).installations_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).name`	string	Required within parent	The name of the GitHub app
`$ (anyOf 1).node_id`	string	Required within parent
`$ (anyOf 1).owner`	JSON	Required within parent
`$ (anyOf 1).owner (anyOf 1)`	Model	Alternative	Expand List users — response body — item
`$ (anyOf 1).owner (anyOf 2)`	Model	Alternative	Expand Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise
`$ (anyOf 1).permissions`	object	Required within parent	The set of permissions for the GitHub app Additional keys: see wildcard field
`$ (anyOf 1).permissions.checks`	string	Optional
`$ (anyOf 1).permissions.contents`	string	Optional
`$ (anyOf 1).permissions.deployments`	string	Optional
`$ (anyOf 1).permissions.issues`	string	Optional
`$ (anyOf 1).permissions.metadata`	string	Optional
`$ (anyOf 1).permissions.*`	string	Additional keys
`$ (anyOf 1).slug`	string	Optional	The slug name of the GitHub app
`$ (anyOf 1).updated_at`	string	Required within parent	Format: date-time
`$ (anyOf 2)`	null	Alternative

Referenced models: Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise, List users — response body — item

Get an issue event — response body — dismissed review

Field	Type	Presence	Description and constraints
`$`	object	Root
`dismissal_commit_id`	JSON	Optional
`dismissal_commit_id (anyOf 1)`	string	Alternative
`dismissal_commit_id (anyOf 2)`	null	Alternative
`dismissal_message`	JSON	Required within parent
`dismissal_message (anyOf 1)`	string	Alternative
`dismissal_message (anyOf 2)`	null	Alternative
`review_id`	JSON	Required within parent
`review_id (anyOf 1)`	integer	Alternative
`review_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`state`	string	Required within parent

Policy, approvals and errors

SDK function policy ID: github.issues_get_event. Catalog operation: issues/get-event. 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

Report an issue with this page