See what a GitHub connection can do and what it needs
What you can call today
Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.
const url = 'https://api.xovris.ai/v1/connections/example/github';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/connections/example/github \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”Done.
object
object
object
Example
{ "connectionId": "string", "installation": { "account": "string", "repositories": [ "string" ], "installedAt": "string" }, "consent": { "repository": "string", "grantedBy": "string", "grantedAt": "string", "textVersion": "string" }, "consentText": { "version": "string", "text": "string" }, "pullRequest": { "repository": "string", "number": 1, "url": "string", "branch": "string", "base": "string", "state": "open", "headSha": "string", "checks": { "total": 1, "passed": 1, "failed": 1, "pending": 1, "readAt": "string" }, "changes": [ { "path": "string", "kind": "created", "why": "string" } ], "filesRead": [ "string" ], "lockfile": "unchanged", "path": "ci", "openedAt": "string", "readBackAt": "string", "mergedAt": "string", "closedAt": "string", "branchDeletedAt": "string", "next": "string" }, "next": "string"}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Signed in, but this token or role may not do this. The answer names the permission it needs.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Nothing with that id here, or it belongs to another workspace. Nothing was changed.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Your data is never used to train our AI. How your data is kept
A problem is called fixed only once it works again. How each fix is checked
XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.