Repository

Create a check run for a repository

post

Creates a check run on a commit with optional code annotations. Supports GitHub check runs and Azure DevOps build status. Useful for reporting CI/CD results, code quality checks, or custom validations. Annotations can highlight specific lines in files with issues.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

shastringRequired

Commit SHA to create the check for. For PRs, this should be the head commit SHA.

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

pull_numbernumberOptional

Pull request number. If provided, the check will be associated with this PR.

Example: 123

titlestringRequired

Title of the check run

Example: sfp Metadata Duplicate Check

summarystringRequired

Summary of the check results

textstringOptional

Additional details about the check run

details_urlstringOptional

Details URL that will appear in the GitHub UI

Example: https://your-server.com/check-details/123

conclusionstring · enumOptional

Conclusion of the check run. Required when status is completed.

Default: successExample: successPossible values:

statusstring · enumOptional

Status of the check run. Defaults to completed.

Default: completedExample: completedPossible values:

skip_commentbooleanOptional

Skip posting a rich PR comment (ADO only). Use when the status badge is sufficient.

Default: false

check_categorystringOptional

Category of the check (analysis or validation). Used to construct web UI result page URLs.

Example: validation

Responses

201

The check run has been successfully created

application/json

403

Forbidden - Requires role: owner, application

post

/sfp/api/repository/checks

HTTPcURLJavaScriptPython

POST /sfp/api/repository/checks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 442

{
  "repositoryIdentifier": "text",
  "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "pull_number": 123,
  "title": "sfp Metadata Duplicate Check",
  "summary": "text",
  "text": "text",
  "annotations": [
    {
      "path": "text",
      "start_line": 1,
      "end_line": 1,
      "annotation_level": "warning",
      "message": "text",
      "title": "text"
    }
  ],
  "details_url": "https://your-server.com/check-details/123",
  "conclusion": "success",
  "status": "completed",
  "skip_comment": false,
  "check_category": "validation"
}

{
  "id": 1,
  "html_url": "text",
  "conclusion": "success",
  "status": "completed"
}

Create a pull request in a repository

post

Creates a new pull request between two branches. Supports draft pull requests. The source branch must have commits ahead of the target branch. Useful for automated PR creation in CI/CD workflows.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: octocat/Hello-World

sourceBranchstringRequired

The source branch containing the changes

Example: feature-branch

targetBranchstringRequired

The target branch to merge changes into

Example: main

titlestringRequired

Title of the pull request

Example: Add new feature

descriptionstringOptional

Description of the pull request in markdown format

Example: This PR implements the following: - Feature A - Feature B

draftbooleanOptional

Whether to create as a draft pull request

Default: false

userTokenstringOptional

Personal access token to create the PR as a specific user. For GitHub: use a PAT with repo scope. For GitLab: use a PAT with api scope. If omitted, PR is created using the configured app credentials.

Responses

201

The pull request has been successfully created

application/json

403

Forbidden - Requires role: owner, application

post

/sfp/api/repository/pull-requests

HTTPcURLJavaScriptPython

POST /sfp/api/repository/pull-requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "repositoryIdentifier": "octocat/Hello-World",
  "sourceBranch": "feature-branch",
  "targetBranch": "main",
  "title": "Add new feature",
  "description": "This PR implements the following:\n- Feature A\n- Feature B",
  "draft": false,
  "userToken": "text"
}

{
  "id": 1,
  "number": 1,
  "html_url": "text",
  "state": "open",
  "title": "text",
  "body": "text",
  "draft": true
}

Handle incoming GitHub webhook events

post

Processes incoming GitHub webhook events. This is the endpoint that GitHub calls when events occur in the repository.

Header parameters

x-github-eventstringRequired

x-github-deliverystringRequired

x-hub-signature-256stringRequired

Responses

200

The webhook event has been processed successfully

No content

post

/sfp/api/repository/webhook

HTTPcURLJavaScriptPython

POST /sfp/api/repository/webhook HTTP/1.1
x-github-event: text
x-github-delivery: text
x-hub-signature-256: text
Accept: */*

200

The webhook event has been processed successfully

No content

Reopen a pull request

patch

Reopens a previously closed pull request. The PR must not have been merged. All previous history including comments and reviews is preserved.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: flxbl-io/sf-core

Responses

200

The pull request has been successfully reopened

application/json

403

Forbidden - Requires role: owner, application

patch

/sfp/api/repository/pull-requests/{pull_number}/reopen

HTTPcURLJavaScriptPython

PATCH /sfp/api/repository/pull-requests/{pull_number}/reopen HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "repositoryIdentifier": "flxbl-io/sf-core"
}

{
  "id": 1,
  "number": 1,
  "state": "open"
}

List open pull requests in a repository

get

Lists pull requests with optional filtering by username and state. Supports GitHub and Azure DevOps repositories. Supports pagination. Can filter PRs created by or assigned to a specific user. Returns basic PR information including title, state, and branch details.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

usernamestringOptional

Filter pull requests by username

statestring · enumOptional

State of pull requests to return (default: open)

Possible values:

pagenumberOptional

Page number (1-based, default: 1)

per_pagenumberOptional

Number of results per page (default: 30, max: 100)

Responses

200

List of pull requests

application/json

403

Forbidden - Requires role: owner, application

get

/sfp/api/repository/pull-requests

HTTPcURLJavaScriptPython

GET /sfp/api/repository/pull-requests?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Close a pull request

patch

Closes an open pull request without merging. The PR can be reopened later if needed. This action preserves all PR history including comments and reviews.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: flxbl-io/sf-core

Responses

200

The pull request has been successfully closed

application/json

403

Forbidden - Requires role: owner, application

patch

/sfp/api/repository/pull-requests/{pull_number}/close

HTTPcURLJavaScriptPython

PATCH /sfp/api/repository/pull-requests/{pull_number}/close HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "repositoryIdentifier": "flxbl-io/sf-core"
}

{
  "id": 1,
  "number": 1,
  "state": "closed"
}