GitHub

Setup GitHub connector

Changed on

Creates a GitHub connector account, instance, target, and initial mappings in one flow.

post/v1/connectors/github/setup

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/connectors/github/setup
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

installationIdinteger required
connectorAccountIdstring typeid

Den TypeID with 'cac_' prefix and a 26-character base32 suffix.

connectorInstanceNamestring required
repositoryIdinteger required
repositoryFullNamestring required
branchstring required
refstring required

Response

GitHub connector setup created successfully.

oktrue required

Changes

  • df3754993784Revision changes
    • info

      added the optional property to the response with the status

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API