README.md

GraphQL Interface for HubProxy

This package implements a GraphQL interface for HubProxy that mirrors the functionality of the REST API.

Endpoints

The GraphQL interface is available at /graphql on the API server.

Queries

events - List webhook events

query {
  events(
    type: String
    repository: String
    sender: String
    status: String
    since: DateTime
    until: DateTime
    limit: Int
    offset: Int
  ) {
    events {
      id
      type
      payload
      createdAt
      status
      error
      repository
      sender
      replayedFrom
      originalTime
    }
    total
  }
}

event - Get a single webhook event by ID

query {
  event(id: "event-id") {
    id
    type
    payload
    createdAt
    status
    error
    repository
    sender
    replayedFrom
    originalTime
  }
}

stats - Get webhook event statistics

query {
  stats(since: "2023-01-01T00:00:00Z") {
    type
    count
  }
}

Mutations

replayEvent - Replay a single webhook event

mutation {
  replayEvent(id: "event-id") {
    replayedCount
    events {
      id
      type
      payload
      createdAt
      status
      repository
      sender
      replayedFrom
      originalTime
    }
  }
}

replayRange - Replay multiple webhook events within a time range

mutation {
  replayRange(
    since: "2023-01-01T00:00:00Z"
    until: "2023-01-02T00:00:00Z"
    type: String
    repository: String
    sender: String
    limit: Int
  ) {
    replayedCount
    events {
      id
      type
      payload
      createdAt
      status
      repository
      sender
      replayedFrom
      originalTime
    }
  }
}

Interactive Tools

The GraphQL endpoint includes:

• GraphiQL: An interactive in-browser GraphQL IDE
• Playground: An alternative GraphQL IDE

These tools are available directly at the /graphql endpoint when accessed from a browser.