github.issues

This event occurs when there is activity on a Github issue, such as creation or editing.

@on("github.issues")
def agent(input):
    pass

The following is an example payload which is passed in as an argument to your agent’s entrypoint:

json

{
  "$raw": {},
  "action": "opened",
  "issue": {
    "author": "octocat",
    "body": "When trying to login with GitHub, the callback URL is not handling special characters correctly.",
    "comments": [
      {
        "author": "other-user",
        "body": "I can reproduce this issue. It happens when the username contains '@' symbol.",
        "created_at": "2024-03-21T14:35:00Z",
        "id": 987654321,
        "node_id": "MDEyOklzc3VlQ29tbWVudDk4NzY1NDMyMQ==",
        "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/987654321"
      }
    ],
    "created_at": "2024-03-21T14:30:00Z",
    "id": 1234567890,
    "labels": [
      {
        "color": "d73a4a",
        "default": true,
        "description": "Something isn't working",
        "id": 123456,
        "name": "bug",
        "node_id": "MDU6TGFiZWwxMjM0NTY="
      },
      {
        "color": "b60205",
        "default": false,
        "description": "Needs immediate attention",
        "id": 789012,
        "name": "high-priority",
        "node_id": "MDU6TGFiZWw3ODkwMTI="
      }
    ],
    "node_id": "MDU6SXNzdWUxMjM0NTY3ODkw",
    "number": 42,
    "state": "open",
    "title": "Found a bug in the authentication flow",
    "url": "https://api.github.com/repos/octocat/Hello-World/issues/42"
  },
  "owner": "octocat",
  "repo": "Hello-World"
}

def agent(input):
    $raw = input.get("$raw")
    action = input.get("action")
    issue = input.get("issue")
    owner = input.get("owner")
    repo = input.get("repo")

Fields

$raw · object

The raw Github issues event payload.

action · string

The action that occurred on the issue.

Show action values

opened · string

The issue was opened.

edited · string

The issue was edited. For example, the title or description was changed.

issue · object

The issue that the event is on.

Show issue properties

author · string

The author of the issue.

body · string

The body of the issue.

comments · object[]

The comments on the issue.

Show comment properties

author · string

The author of the comment.

body · string

The body of the comment.

created_at · string

The date and time the comment was created.

id · number

The ID of the comment.

node_id · string

The node ID of the comment.

url · string

The URL of the comment.

created_at · string

The date and time the issue was created.

id · number

The ID of the issue.

labels · object[]

The labels on the issue.

Show label properties

color · string

The color of the label.

default · boolean

Whether the label is the default label.

description · string

The description of the label.

id · number

The ID of the label.

name · string

The name of the label.

node_id · string

The node ID of the label.

node_id · string

The node ID of the issue.

number · number

The number of the issue.

state · string

The state of the issue.

title · string

The title of the issue.

url · string

The URL of the issue.

owner · string

The owner of the repository.

repo · string

The name of the repository.