RSX · API · Reference

webhooks v1

GitHub App event receiver that relays repository activity (push, PRs, CI, releases) to Discord.

openapi.json

Current

Base URL: https://api.rsx.group/webhooks/v1
Self-grantable scopes: None. Every endpoint here needs a key issued by a platform admin.
Machine readable: openapi.json

admin

7 operations under /webhooks/v1/admin.

GET/webhooks/v1/admin/status

Report whether the GitHub + Discord integration is configured

Scope: webhooks:admin:status Admin-issued keys only.

Response 200Configuration status

Response of webhooksStatus
Field	Type	Description
datarequired	object
githubConfiguredrequired	boolean
discordConfiguredrequired	boolean
appSlugrequired	string, or null	GitHub App slug, for the install deep link.

datarequired
Type
object
Description
githubConfiguredrequired
Type
boolean
Description
discordConfiguredrequired
Type
boolean
Description
appSlugrequired
Type
string, or null
Description
GitHub App slug, for the install deep link.

Example

curl

curl "https://api.rsx.group/webhooks/v1/admin/status" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "githubConfigured": true,
    "discordConfigured": true,
    "appSlug": "string"
  }
}

GET/webhooks/v1/admin/installations

List GitHub App installations

Scope: webhooks:admin:installations Admin-issued keys only.

Response 200Installations

Response of listInstallations
Field	Type	Description
datarequired	array of WebhookInstallation
installationIdrequired	string
accountLoginrequired	string
accountTyperequired	string
createdAtrequired	string, date-time
suspendedAtrequired	string, date-time, or null
repoCountrequired	integer

datarequired
Type
array of WebhookInstallation
Description
installationIdrequired
Type
string
Description
accountLoginrequired
Type
string
Description
accountTyperequired
Type
string
Description
createdAtrequired
Type
string, date-time
Description
suspendedAtrequired
Type
string, date-time, or null
Description
repoCountrequired
Type
integer
Description

Example

curl

curl "https://api.rsx.group/webhooks/v1/admin/installations" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "installationId": "48291733",
      "accountLogin": "whitehill-group",
      "accountType": "Organization",
      "createdAt": "2026-10-10T12:00:00.000Z",
      "suspendedAt": "2026-10-10T12:00:00.000Z",
      "repoCount": 3
    }
  ]
}

GET/webhooks/v1/admin/repos

List repositories and their relay config

Scope: webhooks:admin:repos Admin-issued keys only.

Response 200Repositories

Response of listWebhookRepos
Field	Type	Description
datarequired	array of WebhookRepo
idrequired	string, uuid
installationIdrequired	string
fullNamerequired	string
privaterequired	boolean
enabledrequired	boolean	Whether events for this repo are relayed to Discord.
eventsrequired	WebhookEvents	Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
hideBotsrequired	boolean	Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired	array of object	Ping targets keyed by event + condition.
idrequired	string
eventrequired	string
condition	string	CI conclusion, or the catalog action.
targetsrequired	array of one of object, object, object, object, object
descriptionrequired	string, or null	Repo description, shown in the channel topic.
discordChannelIdrequired	string, or null
createdAtrequired	string, date-time
updatedAtrequired	string, date-time
lastErrorrequired	string, or null	Current relay/permission problem, or null when healthy.
lastErrorAtrequired	string, date-time, or null
lastOkAtrequired	string, date-time, or null	Last successful enable/relay.

datarequired
Type
array of WebhookRepo
Description
idrequired
Type
string, uuid
Description
installationIdrequired
Type
string
Description
fullNamerequired
Type
string
Description
privaterequired
Type
boolean
Description
enabledrequired
Type
boolean
Description
Whether events for this repo are relayed to Discord.
eventsrequired
Type
WebhookEvents
Description
Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
hideBotsrequired
Type
boolean
Description
Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired
Type
array of object
Description
Ping targets keyed by event + condition.
idrequired
Type
string
Description
eventrequired
Type
string
Description
condition
Type
string
Description
CI conclusion, or the catalog action.
targetsrequired
Type
array of one of object, object, object, object, object
Description
descriptionrequired
Type
string, or null
Description
Repo description, shown in the channel topic.
discordChannelIdrequired
Type
string, or null
Description
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description
lastErrorrequired
Type
string, or null
Description
Current relay/permission problem, or null when healthy.
lastErrorAtrequired
Type
string, date-time, or null
Description
lastOkAtrequired
Type
string, date-time, or null
Description
Last successful enable/relay.

Example

curl

curl "https://api.rsx.group/webhooks/v1/admin/repos" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "installationId": "48291733",
      "fullName": "whitehill-group/rsx-infra",
      "private": true,
      "enabled": true,
      "events": {
        "key": [
          "string"
        ]
      },
      "hideBots": true,
      "pingRules": [
        {
          "id": "string",
          "event": "workflow_run",
          "condition": "failure",
          "targets": [
            {
              "kind": null,
              "id": null
            }
          ]
        }
      ],
      "description": "string",
      "discordChannelId": "1180000000000000000",
      "createdAt": "2026-10-10T12:00:00.000Z",
      "updatedAt": "2026-10-10T12:00:00.000Z",
      "lastError": "string",
      "lastErrorAt": "2026-10-10T12:00:00.000Z",
      "lastOkAt": "2026-10-10T12:00:00.000Z"
    }
  ]
}

POST/webhooks/v1/admin/repos/configure

Enable/disable a repo and set its relayed events

Scope: webhooks:admin:repos:configure Admin-issued keys only.

Request bodyapplication/json

Request body of configureWebhookRepo
Field	Type	Description
repoIdrequired	string, uuid
enabled	boolean
events	WebhookEvents	Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
{key}	array of string
hideBots	boolean
pingRules	array of object
idrequired	string
eventrequired	string
condition	string	CI conclusion, or the catalog action.
targetsrequired	array of one of object, object, object, object, object

repoIdrequired
Type
string, uuid
Description
enabled
Type
boolean
Description
events
Type
WebhookEvents
Description
Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
{key}
Type
array of string
Description
hideBots
Type
boolean
Description
pingRules
Type
array of object
Description
idrequired
Type
string
Description
eventrequired
Type
string
Description
condition
Type
string
Description
CI conclusion, or the catalog action.
targetsrequired
Type
array of one of object, object, object, object, object
Description

Response 200Updated

Response of configureWebhookRepo
Field	Type	Description
datarequired	WebhookRepo
idrequired	string, uuid
installationIdrequired	string
fullNamerequired	string
privaterequired	boolean
enabledrequired	boolean	Whether events for this repo are relayed to Discord.
eventsrequired	WebhookEvents	Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
hideBotsrequired	boolean	Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired	array of object	Ping targets keyed by event + condition.
idrequired	string
eventrequired	string
condition	string	CI conclusion, or the catalog action.
targetsrequired	array of one of object, object, object, object, object
descriptionrequired	string, or null	Repo description, shown in the channel topic.
discordChannelIdrequired	string, or null
createdAtrequired	string, date-time
updatedAtrequired	string, date-time
lastErrorrequired	string, or null	Current relay/permission problem, or null when healthy.
lastErrorAtrequired	string, date-time, or null
lastOkAtrequired	string, date-time, or null	Last successful enable/relay.

datarequired
Type
WebhookRepo
Description
idrequired
Type
string, uuid
Description
installationIdrequired
Type
string
Description
fullNamerequired
Type
string
Description
privaterequired
Type
boolean
Description
enabledrequired
Type
boolean
Description
Whether events for this repo are relayed to Discord.
eventsrequired
Type
WebhookEvents
Description
Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
hideBotsrequired
Type
boolean
Description
Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired
Type
array of object
Description
Ping targets keyed by event + condition.
idrequired
Type
string
Description
eventrequired
Type
string
Description
condition
Type
string
Description
CI conclusion, or the catalog action.
targetsrequired
Type
array of one of object, object, object, object, object
Description
descriptionrequired
Type
string, or null
Description
Repo description, shown in the channel topic.
discordChannelIdrequired
Type
string, or null
Description
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description
lastErrorrequired
Type
string, or null
Description
Current relay/permission problem, or null when healthy.
lastErrorAtrequired
Type
string, date-time, or null
Description
lastOkAtrequired
Type
string, date-time, or null
Description
Last successful enable/relay.

Example

curl

curl -X POST https://api.rsx.group/webhooks/v1/admin/repos/configure \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "repoId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
  "enabled": true,
  "events": {
    "key": [
      "string"
    ]
  },
  "hideBots": true,
  "pingRules": [
    {
      "id": "string",
      "event": "workflow_run",
      "condition": "failure",
      "targets": [
        {
          "kind": "user",
          "id": "string"
        }
      ]
    }
  ]
}'

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "installationId": "48291733",
    "fullName": "whitehill-group/rsx-infra",
    "private": true,
    "enabled": true,
    "events": {
      "key": [
        "string"
      ]
    },
    "hideBots": true,
    "pingRules": [
      {
        "id": "string",
        "event": "workflow_run",
        "condition": "failure",
        "targets": [
          {
            "kind": "user",
            "id": "string"
          }
        ]
      }
    ],
    "description": "string",
    "discordChannelId": "1180000000000000000",
    "createdAt": "2026-10-10T12:00:00.000Z",
    "updatedAt": "2026-10-10T12:00:00.000Z",
    "lastError": "string",
    "lastErrorAt": "2026-10-10T12:00:00.000Z",
    "lastOkAt": "2026-10-10T12:00:00.000Z"
  }
}

POST/webhooks/v1/admin/repos/disconnect

Delete a repo's Discord channel and disable its relay

Scope: webhooks:admin:repos:disconnect Admin-issued keys only.

Request bodyapplication/json

Request body of disconnectWebhookRepo
Field	Type	Description
repoIdrequired	string, uuid

repoIdrequired
Type
string, uuid
Description

Response 200Disconnected

Response of disconnectWebhookRepo
Field	Type	Description
datarequired	WebhookRepo
idrequired	string, uuid
installationIdrequired	string
fullNamerequired	string
privaterequired	boolean
enabledrequired	boolean	Whether events for this repo are relayed to Discord.
eventsrequired	WebhookEvents	Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
hideBotsrequired	boolean	Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired	array of object	Ping targets keyed by event + condition.
idrequired	string
eventrequired	string
condition	string	CI conclusion, or the catalog action.
targetsrequired	array of one of object, object, object, object, object
descriptionrequired	string, or null	Repo description, shown in the channel topic.
discordChannelIdrequired	string, or null
createdAtrequired	string, date-time
updatedAtrequired	string, date-time
lastErrorrequired	string, or null	Current relay/permission problem, or null when healthy.
lastErrorAtrequired	string, date-time, or null
lastOkAtrequired	string, date-time, or null	Last successful enable/relay.

datarequired
Type
WebhookRepo
Description
idrequired
Type
string, uuid
Description
installationIdrequired
Type
string
Description
fullNamerequired
Type
string
Description
privaterequired
Type
boolean
Description
enabledrequired
Type
boolean
Description
Whether events for this repo are relayed to Discord.
eventsrequired
Type
WebhookEvents
Description
Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
hideBotsrequired
Type
boolean
Description
Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired
Type
array of object
Description
Ping targets keyed by event + condition.
idrequired
Type
string
Description
eventrequired
Type
string
Description
condition
Type
string
Description
CI conclusion, or the catalog action.
targetsrequired
Type
array of one of object, object, object, object, object
Description
descriptionrequired
Type
string, or null
Description
Repo description, shown in the channel topic.
discordChannelIdrequired
Type
string, or null
Description
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description
lastErrorrequired
Type
string, or null
Description
Current relay/permission problem, or null when healthy.
lastErrorAtrequired
Type
string, date-time, or null
Description
lastOkAtrequired
Type
string, date-time, or null
Description
Last successful enable/relay.

Example

curl

curl -X POST https://api.rsx.group/webhooks/v1/admin/repos/disconnect \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "repoId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d"
}'

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "installationId": "48291733",
    "fullName": "whitehill-group/rsx-infra",
    "private": true,
    "enabled": true,
    "events": {
      "key": [
        "string"
      ]
    },
    "hideBots": true,
    "pingRules": [
      {
        "id": "string",
        "event": "workflow_run",
        "condition": "failure",
        "targets": [
          {
            "kind": "user",
            "id": "string"
          }
        ]
      }
    ],
    "description": "string",
    "discordChannelId": "1180000000000000000",
    "createdAt": "2026-10-10T12:00:00.000Z",
    "updatedAt": "2026-10-10T12:00:00.000Z",
    "lastError": "string",
    "lastErrorAt": "2026-10-10T12:00:00.000Z",
    "lastOkAt": "2026-10-10T12:00:00.000Z"
  }
}

GET/webhooks/v1/admin/deliveries

List recent webhook deliveries

Scope: webhooks:admin:deliveries Admin-issued keys only.

Query parameters

Query parameters of listDeliveries
Parameter	Type	Description
cursor	string
limit	integer	1 to 100 · default 50

cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 50

Response 200Deliveries, newest first

Response of listDeliveries
Field	Type	Description
datarequired	array of WebhookDelivery
idrequired	string, uuid
deliveryIdrequired	string	GitHub X-GitHub-Delivery id.
eventrequired	string
actionrequired	string, or null
repoFullNamerequired	string, or null
statusrequired	string	posted → relayed; skipped → repo/event off; ignored → unsupported/dup; error → relay failed.one of "posted", "skipped", "ignored", "error"
detailrequired	string, or null
atrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of WebhookDelivery
Description
idrequired
Type
string, uuid
Description
deliveryIdrequired
Type
string
Description
GitHub X-GitHub-Delivery id.
eventrequired
Type
string
Description
actionrequired
Type
string, or null
Description
repoFullNamerequired
Type
string, or null
Description
statusrequired
Type
string
Description
posted → relayed; skipped → repo/event off; ignored → unsupported/dup; error → relay failed.one of "posted", "skipped", "ignored", "error"
detailrequired
Type
string, or null
Description
atrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/webhooks/v1/admin/deliveries" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "deliveryId": "8f9a…",
      "event": "push",
      "action": "opened",
      "repoFullName": "whitehill-group/rsx-infra",
      "status": "posted",
      "detail": "string",
      "at": "2026-10-10T12:00:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

GET/webhooks/v1/admin/audit

List operator changes to repo relay config

Scope: webhooks:admin:audit Admin-issued keys only.

Query parameters

Query parameters of listRepoAudit
Parameter	Type	Description
cursor	string
limit	integer	1 to 100 · default 50

cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 50

Response 200Audit records, newest first

Response of listRepoAudit
Field	Type	Description
datarequired	array of RepoAuditRecord
idrequired	string, uuid
actorrequired	string
actionrequired	string	one of "enabled", "disabled", "events_changed", "filters_changed", "pings_changed", "disconnected"
repoIdrequired	string, uuid
repoFullNamerequired	string
atrequired	string, date-time
detailrequired	string, or null
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of RepoAuditRecord
Description
idrequired
Type
string, uuid
Description
actorrequired
Type
string
Description
actionrequired
Type
string
Description
one of "enabled", "disabled", "events_changed", "filters_changed", "pings_changed", "disconnected"
repoIdrequired
Type
string, uuid
Description
repoFullNamerequired
Type
string
Description
atrequired
Type
string, date-time
Description
detailrequired
Type
string, or null
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/webhooks/v1/admin/audit" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "actor": "ada@rsx.group",
      "action": "enabled",
      "repoId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "repoFullName": "whitehill-group/rsx-infra",
      "at": "2026-10-10T12:00:00.000Z",
      "detail": "events: 3 → 5 families"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

Schemas

Every named shape in this reference, as the operations above refer to it.

WebhookInstallation

WebhookInstallation
Field	Type	Description
installationIdrequired	string
accountLoginrequired	string
accountTyperequired	string
createdAtrequired	string, date-time
suspendedAtrequired	string, date-time, or null
repoCountrequired	integer

installationIdrequired
Type
string
Description
accountLoginrequired
Type
string
Description
accountTyperequired
Type
string
Description
createdAtrequired
Type
string, date-time
Description
suspendedAtrequired
Type
string, date-time, or null
Description
repoCountrequired
Type
integer
Description

WebhookEvents

Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).

WebhookEvents
Field	Type	Description
{key}	array of string

{key}
Type
array of string
Description

WebhookRepo

WebhookRepo
Field	Type	Description
idrequired	string, uuid
installationIdrequired	string
fullNamerequired	string
privaterequired	boolean
enabledrequired	boolean	Whether events for this repo are relayed to Discord.
eventsrequired	WebhookEvents	Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
{key}	array of string
hideBotsrequired	boolean	Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired	array of object	Ping targets keyed by event + condition.
idrequired	string
eventrequired	string
condition	string	CI conclusion, or the catalog action.
targetsrequired	array of one of object, object, object, object, object
descriptionrequired	string, or null	Repo description, shown in the channel topic.
discordChannelIdrequired	string, or null
createdAtrequired	string, date-time
updatedAtrequired	string, date-time
lastErrorrequired	string, or null	Current relay/permission problem, or null when healthy.
lastErrorAtrequired	string, date-time, or null
lastOkAtrequired	string, date-time, or null	Last successful enable/relay.

idrequired
Type
string, uuid
Description
installationIdrequired
Type
string
Description
fullNamerequired
Type
string
Description
privaterequired
Type
boolean
Description
enabledrequired
Type
boolean
Description
Whether events for this repo are relayed to Discord.
eventsrequired
Type
WebhookEvents
Description
Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
{key}
Type
array of string
Description
hideBotsrequired
Type
boolean
Description
Skip activity from bot actors (dependabot, github-actions, …).
pingRulesrequired
Type
array of object
Description
Ping targets keyed by event + condition.
idrequired
Type
string
Description
eventrequired
Type
string
Description
condition
Type
string
Description
CI conclusion, or the catalog action.
targetsrequired
Type
array of one of object, object, object, object, object
Description
descriptionrequired
Type
string, or null
Description
Repo description, shown in the channel topic.
discordChannelIdrequired
Type
string, or null
Description
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description
lastErrorrequired
Type
string, or null
Description
Current relay/permission problem, or null when healthy.
lastErrorAtrequired
Type
string, date-time, or null
Description
lastOkAtrequired
Type
string, date-time, or null
Description
Last successful enable/relay.

ConfigureRepo

ConfigureRepo
Field	Type	Description
repoIdrequired	string, uuid
enabled	boolean
events	WebhookEvents	Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
{key}	array of string
hideBots	boolean
pingRules	array of object
idrequired	string
eventrequired	string
condition	string	CI conclusion, or the catalog action.
targetsrequired	array of one of object, object, object, object, object

repoIdrequired
Type
string, uuid
Description
enabled
Type
boolean
Description
events
Type
WebhookEvents
Description
Enabled events keyed by family → enabled action keys. Atomic families use [] (present = on).
{key}
Type
array of string
Description
hideBots
Type
boolean
Description
pingRules
Type
array of object
Description
idrequired
Type
string
Description
eventrequired
Type
string
Description
condition
Type
string
Description
CI conclusion, or the catalog action.
targetsrequired
Type
array of one of object, object, object, object, object
Description

DisconnectRepo

DisconnectRepo
Field	Type	Description
repoIdrequired	string, uuid

repoIdrequired
Type
string, uuid
Description

WebhookDelivery

WebhookDelivery
Field	Type	Description
idrequired	string, uuid
deliveryIdrequired	string	GitHub X-GitHub-Delivery id.
eventrequired	string
actionrequired	string, or null
repoFullNamerequired	string, or null
statusrequired	string	posted → relayed; skipped → repo/event off; ignored → unsupported/dup; error → relay failed.one of "posted", "skipped", "ignored", "error"
detailrequired	string, or null
atrequired	string, date-time

idrequired
Type
string, uuid
Description
deliveryIdrequired
Type
string
Description
GitHub X-GitHub-Delivery id.
eventrequired
Type
string
Description
actionrequired
Type
string, or null
Description
repoFullNamerequired
Type
string, or null
Description
statusrequired
Type
string
Description
posted → relayed; skipped → repo/event off; ignored → unsupported/dup; error → relay failed.one of "posted", "skipped", "ignored", "error"
detailrequired
Type
string, or null
Description
atrequired
Type
string, date-time
Description

RepoAuditRecord

RepoAuditRecord
Field	Type	Description
idrequired	string, uuid
actorrequired	string
actionrequired	string	one of "enabled", "disabled", "events_changed", "filters_changed", "pings_changed", "disconnected"
repoIdrequired	string, uuid
repoFullNamerequired	string
atrequired	string, date-time
detailrequired	string, or null

idrequired
Type
string, uuid
Description
actorrequired
Type
string
Description
actionrequired
Type
string
Description
one of "enabled", "disabled", "events_changed", "filters_changed", "pings_changed", "disconnected"
repoIdrequired
Type
string, uuid
Description
repoFullNamerequired
Type
string
Description
atrequired
Type
string, date-time
Description
detailrequired
Type
string, or null
Description