List or stream change events (repo_id addressing)

curl --request GET \
  --url https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "events": [
    {
      "actor_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "<string>",
      "id": "<string>",
      "payload": "<unknown>",
      "review_id": "<string>",
      "target_id": "<string>",
      "target_type": "<string>",
      "trail_id": "<string>"
    }
  ],
  "$schema": "/api/v1/schemas/ReviewEventsResponseBody.json",
  "next_cursor": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

Activity

List or stream change events (repo_id addressing)

Users Plugins

Accepted credentials: User token, Plugin installation token.

Returns trail events by opaque repo id with the same JSON cursor pagination, category filters, open event catalog, Last-Event-ID SSE resume, and from=head latest-push start as the name-addressed route.

Use an own-account bearer token (including supported service accounts) or a Core-issued plugin installation bearer token, subject to the permissions and restrictions below. Plugin assertion JWTs and plugin OAuth user-delegation tokens are not accepted here.

Requires live repository pull permission (contents:read for plugin installations). Other authorized automation principals can also use this operation. Trails must be enabled. Send requests to the repository’s primary API region. Streams recheck credentials, repository access and placement.

GET

repos

{repo_id}

changes

{number}

events

List or stream change events (repo_id addressing)

curl --request GET \
  --url https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "events": [
    {
      "actor_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "<string>",
      "id": "<string>",
      "payload": "<unknown>",
      "review_id": "<string>",
      "target_id": "<string>",
      "target_type": "<string>",
      "trail_id": "<string>"
    }
  ],
  "$schema": "/api/v1/schemas/ReviewEventsResponseBody.json",
  "next_cursor": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authorization code flow.

Headers

string

text/event-stream streams events; otherwise returns a JSON page.

Last-Event-ID

string

SSE numeric resume cursor; falls back to after.

Path Parameters

repo_id

string

required

number

string

required

Query Parameters

type

string[] | null

Alias for type[eq]; repeatable or comma-separated.

type[eq]

string[] | null

Match runner, monitor, or finding categories; repeatable or comma-separated.

type[ne]

string[] | null

Exclude runner, monitor, or finding categories; repeatable or comma-separated.

cursor

string

Opaque JSON-page continuation. Filters may be omitted or repeated with matching values.

per_page

string

JSON page size: default 200, capped at 1000; zero returns an empty page.

after

string

Numeric resume cursor: for SSE, used when Last-Event-ID is absent; for JSON pages, an alternative first-page start to cursor (mutually exclusive with cursor).

from

enum<string>

head starts at the trail's latest push instead of the first event. For SSE, Last-Event-ID and after take precedence, since they resume a stream; the ready frame reports the start, head_sha and latest_event_id. For JSON pages it starts the first page (empty when the push has no events yet), is mutually exclusive with cursor and after, and the body carries no start metadata: a trail with no head pages the full log.

Available options:

head

Response

JSON event page or SSE stream

events

object[] | null

required

Show child attributes

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"/api/v1/schemas/ReviewEventsResponseBody.json"

next_cursor

string

Documentation

Accounts and projects

Git

Trails

Sessions and checkpoints

Webhooks

List or stream change events (repo_id addressing)

Authorizations

Headers

Path Parameters

Query Parameters

Response