Skip to main content

​
Get Event by ID

GET /api/v1/events/{event_id}
Retrieves detailed information about a specific webhook event.

​
Path Parameters

​
event_id
integer
required
The unique identifier of the event

​
Response

​
id
integer
Unique event identifier
​
event_type
string
GitHub event type (e.g., pull_request)
​
status
string
Processing status: pending, completed, or failed
​
payload
object
Complete GitHub webhook payload
​
created_at
string
ISO 8601 timestamp when event was received
​
processed_at
string
ISO 8601 timestamp when processing completed

​
Debug Event

GET /api/v1/events/{event_id}/debug
Debug endpoint that shows the event payload and associated workflow run errors.

​
Path Parameters

​
event_id
integer
required
The unique identifier of the event

​
Response

​
event
object
Event summary information
​
workflows
array
Associated workflow runs

​
Example Requests

curl https://your-backend.railway.app/api/v1/events/42 \
  -H "Cookie: access_token=your_jwt_token"

​
Example Debug Response

{
  "event": {
    "id": 42,
    "event_type": "pull_request",
    "status": "failed",
    "created_at": "2026-03-10T14:30:00Z"
  },
  "workflows": [
    {
      "id": 15,
      "status": "failed",
      "error": "Neo4j connection timeout",
      "started_at": "2026-03-10T14:30:01Z",
      "completed_at": "2026-03-10T14:30:45Z"
    }
  ]
}

​
Use Cases

  • Troubleshooting: Investigate why a specific PR review failed
  • Debugging: Examine the raw GitHub payload for a webhook event
  • Monitoring: Track workflow execution status and errors
  • Development: Test webhook processing locally with real payloads

​
Error Responses

{
  "detail": "Event not found"
}

List Events

Browse all webhook events

Review Details

View the PR review generated from an event

Build docs developers (and LLMs) love

Get started for freeTalk to us