Docs
Account, keys and webhooks ›

Begin git hub connection

POST/v1/github/connect

Begin git hub connection.

Requestcurl
  1. curl -X POST https://agental.io/v1/github/connect \
  2. -H "Authorization: Bearer $AGENTAL_API_KEY"
Answer200 OK · GitHubConnectStart
  1. {
  2. "url": string,
  3. }

Where to send the browser: GitHub's page that installs the App, with a state good for 30 minutes for this person and organization.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 Where to send the browser: GitHub's page that installs the App, with a state good for 30 minutes for this person and organization.

GitHubConnectStart1 field
url
string

Errors and other answers

403 session_required, or
403forbidden only an owner or an admin of the organization.
409github_not_available runs-on, or the App's sign-in, is not set up on this deployment.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.