Regress

API

Every endpoint lives at https://api.regress.app. Most teams only need the first two, and the deploy guide shows them in use.

Endpoints

  • POST/api/webhook/deploy/:projectId

    Start a scan. Signed with your webhook secret. Returns a checkRunId. Limited to 10 requests a minute.

  • GET/api/webhook/deploy/:projectId/status/:checkRunId

    Get a scan's status, page count, change count and completion time.

  • GET/ws/check/:checkRunId

    WebSocket that streams scan progress and completion as JSON messages.

  • POST/api/webhooks/github

    Receives GitHub App push events. You don't call this one yourself.