GitHub

The GitHub connector lets you perform insert, delete, update, and read operations on GitHub data.

Before you begin

Before using the GitHub connector, do the following tasks:

  • In your Google Cloud project:
    • Ensure that network connectivity is set up. For information about network patterns, seeNetwork connectivity.
    • Grant theroles/connectors.admin IAM role to the user configuring the connector.
    • Grant the following IAM roles to the service account that you want to use for the connector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. The connector and the service account must belong to the same project. For more information, seeCreating a service account.

    • Enable the following services
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      To understand how to enable services, seeEnabling services.

    If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

  • In GitHub, based on your requirement, complete the following tasks:

    Configure the connector

    A connection is specific to a data source. Itmeans that if you have many data sources, you must create a separate connectionfor each data source. To create a connection, do the following:

    1. In theCloud console, go to theIntegration Connectors > Connections page and then select or create a Google Cloud project.

      Go to the Connections page

    2. Click+ CREATE NEW to open theCreate Connection page.
    3. In theLocation section, choose the location for the connection.
      1. Region: Select a location from the drop-down list.

        For the list of all the supported regions, seeLocations.

      2. ClickNEXT.
    4. In theConnection Details section, complete the following:
      1. Connector: SelectGitHub from the drop down list of available Connectors.
      2. Connector version: Select the Connector version from the drop down list of available versions.
      3. In theConnection Name field, enter a name for the Connection instance.

        Connection names must meet the following criteria:

        • Connection names can use letters, numbers, or hyphens.
        • Letters must be lower-case.
        • Connection names must begin with a letter and end with a letter or number.
        • Connection names cannot exceed 49 characters.
      4. Optionally, enter aDescription for the connection instance.
      5. Optionally, enableCloud logging, and then select a log level. By default, the log level is set toError.
      6. Service Account: Select a service account that has therequired roles.
      7. Optionally, specifyOwnerLogin: A unique login name belonging either to a user or an organization.
      8. Optionally, specifySchema: Use schema to restrict the dynamically retrieved schemas to a specific project or repository schema. To retrieve all the schemas, don't specify any value in this field. For information about supported schemas, seeSchemas and scopes
      9. Optionally, configure theConnection node settings:

        • Minimum number of nodes: Enter the minimum number of connection nodes.
        • Maximum number of nodes: Enter the maximum number of connection nodes.

        A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

        10. Note: You can customize the connection node values only if you are a Pay-as-you-go customer.
      10. (Optional) In theAdvanced settings section, select theUse proxy checkbox to configure a proxy server for the connection and configure the following values:
      11. Optionally, click+ ADD LABEL to add a label to the Connection in the form of a key/value pair.
      12. ClickNEXT.
    5. In theDestinations section, enter details of the remote host (backend system) you want to connect to.
      1. Destination Type: Select aDestination Type.

        If you want to establish a public connection to your backend systems with additional security, you can considerconfiguring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.

        To enter additional destinations, click+ADD DESTINATION.

      2. ClickNEXT.
    6. In theAuthentication section, enter the authentication details.

      To understand how to configure these authentication types, seeConfigure authentication.

    7. ClickNEXT.
    8. Review: Review your connection and authentication details.
    9. ClickCreate.

    Configure authentication

    Enter the details based on the authentication you want to use.

    • Client ID: The client ID used for requesting access tokens.
    • Scopes: A comma-separated list of desired scopes.
    • Client Secret: Secret Manager Secret containing the client secret for the connected app you created.

    Connection configuration samples

    This section lists the sample values for the various fields that you configure when creating the connection.

    OAuth 2.0 - authorization code connection type

    Field nameDetails
    Locationeurope-west1
    ConnectorGitHub
    Connector version1
    Connection NameGitHub-connector
    Enable Cloud LoggingNo
    Service AccountYour_Project_Number@serviceaccount
    OwnerLoginsouvikg-Your_Owner_Login
    Schema
    Minimum number of nodes2
    Maximum number of nodes50
    Client IDClientID
    Scopesrepo repo:status repo_deployment
    Client SecretClient secret
    Secret Version1

    GitHub schemas and scopes

    The GitHub connector supports the following schemas:
    • Information schema: This schema contains tables that contain licensing information and high-level overviews of the projects and repositories associated with the authenticated account. Only one information schema exists. To retrieve the information schema, specify the following in the schema field: Information
    • Repository schema: The connector supports schema for each repository in the authenticated user or organization's account. Use the following format to specify a repository schema: Repository_.
    • Project schema: The connector supports schema for each project in the authenticated user or organization's account. Use the following format to specify a project schema: Project_

    For more information about scopes, seeGitHub Scopes.

    Entities, operations, and actions

    All the Integration Connectors provide a layer of abstraction for the objects ofthe connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

    Note: You can view the entities, operations, and actions of a connector in theConnectors task.
    • Entity:An entity can be thought of as an object, or a collection of properties, in theconnected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

      However, it is possible that a connector doesn't support or have any entities, in which case theEntities list will be empty.

    • Operation:An operation is the activity that you can perform on an entity. You can performany of the following operations on an entity:

      Selecting an entity from the available list, generates a list ofoperations available for the entity. For a detailed description of the operations, see the Connectors task'sentity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in theOperations list.

    • Action:An action is a first class function that is made available to the integrationthrough the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case theActions list will be empty.
    Note:All entities and actions will have a schema associated with them. For example, an action schema will have the parameter details such as; the parameternames, and its corresponding data type. The schema (metadata) for entities and actions is fetched by the connection atruntime from your backend. If there are any updates to the schema, such updates won't be automatically reflected in your existing connections; you must manually refresh the schema. To refreshthe schema for a connection, open theConnection details page of the connection, and then clickRefresh connection schema.

    System limitations

    The GitHub connector can process 2 transactions per second, pernode,andthrottles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

    For information on the limits applicable to Integration Connectors, seeLimits.

    Note: The number ofIntegration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:
    • If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
    • If you are a subscription based customer,contact support.

    The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

    Action

    This section lists the action supported by the GitHub connector. To understand how to configure the action, seeAction examples.

    UpdatePullRequestBranch action

    This action updates the pull request branch.

    Input parameters of the UpdatePullRequestBranch action

    NameTypeDescription
    PullRequestIdstringThe Node ID of the pull request.
    ExpectedHeadOidstringThe head ref oid for the upstream branch.
    UpdateMethodstringThe update branch method to use. The default is 'MERGE'. The allowed values are MERGE and REBASE.

    Output parameters of the AppsDeployStatus action

    This action returns the status 200 (OK) and updates pull request branch.

    For example on how to configure theUpdatePullRequestBranch action, seeExamples.

    MergePullRequest action

    This action merges pull request.

    Input parameters of the MergePullRequest action

    NameTypeDescription
    PullRequestIdstringThe Node ID of the pull request to be merged.
    ExpectedHeadOidstringOID that the pull request head ref must match to allow merge; if omitted, no check is performed.
    CommitHeadlinestringCommit headline to use for the merge commit; if omitted, a default message is used.
    CommitBodystringCommit body to use for the merge commit; if omitted, a default message is used.
    MergeMethodstringThe merge method to use. The default is 'MERGE'. The allowed values are MERGE, SQUASH, and REBASE.
    AuthorEmailstringThe email address to associate with this merge.

    Output parameters of the MergePullRequest action

    This action returns the status 200 (OK) and merges pull request.

    For example on how to configure theMergePullRequest action, seeExamples.

    DownloadFile action

    This action downloads a file from the repository.

    Input parameters of the DownloadFile action

    NameTypeRequiredDescription
    PathStringFalseThe path of the file in the repository.
    BranchStringFalseThe branch name in the repository from which the file is downloaded. The default value is main branch.
    LocalPathStringFalseThe local path where the file is saved after download.
    OutputStreamBinaryTrueAn instance of an output stream to which the file data is written. The output stream is used only if the LocalPath is not provided.

    For example on how to configure theDownloadFile action, seeExamples.

    UploadFile action

    This action uploads a file to the repository.

    Input parameters of the UploadFile action

    NameTypeRequiredDescription
    PathStringFalseThe path of the file in the repository.
    BranchStringFalseThe branch name in the repository to upload the file. The default value is main branch.
    CommitMessageStringFalseThe message that describes the changes made during the file upload.
    SHAStringFalseThe hash of the file that is used to verify and update existing files in the repository.
    CommitterNameStringFalseThe user who commits the file. The default value is the authenticated user.
    CommitterEmailStringFalseThe email address of the user who commits the file. The default value is the authenticated user.
    AuthorNameStringFalseThe name of the author who uploads the file. The default value is the committer's name or the authenticated user.
    AuthorEmailStringFalseThe email address of the author who uploads file. The default value is the committer's email or the authenticated user's email.
    LocalPathStringFalseThe local path where the file is saved after download.
    InputStreamBinaryTrueAn input stream instance used to read the file data. This is used only if LocalPath is not specified.
    FileDataStringFalseThe Base64-encoded string representing the file's content. This is used only if LocalPath and InputStream are not specified.

    For example on how to configure theUploadFile action, seeExamples.

    Action examples

    This section describes how to perform some of the actions in this connector.

    Example - UpdatePullRequestBranch

    This example retrieves the deployment statuses of the application.

    1. In theConfigure connector task dialog, clickAction.
    2. Select theUpdatePullRequestBranch action, and then clickDone.
    3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
      {"PullRequestId":"PR_kwDOLywhW8537gcA"}

      4. If the action is successful, theUpdatePullRequestBranch task'sconnectorOutputPayload response parameter will have a value similar to the following:

      {"pullrequestid":"PR_kwDOLywhW8537gcA"}

    Example - MergePullRequest

    This example merges a pull request.

    1. In theConfigure connector task dialog, clickAction.
    2. Select theMergePullRequest action, and then clickDone.
    3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
      {"PullRequestId":"PR_kwDOLywhW8537gcA","CommitHeadline":"Google MERGE","CommitBody":"This is Google Merge"}

      4. If the action is successful, theMergePullRequest task'sconnectorOutputPayload response parameter will have a value similar to the following:

      {"pullrequestid":"PR_kwDOLywhW8537gcA"}

    Example - Download a file from the repository

    1. In theConfigure connector task dialog, clickActions.
    2. Select theDownloadFile action, and then clickDone.
    3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
            {    "Repository": "Google_GitHub_Testing",    "Path": "Test_Document.txt"      }

      4. If the action is successful, theDownloadFile task'sconnectorOutputPayload response parameter will have a value similar to the following:

          {      "Success": true,      "Details": null,      "FileData": "SGkgR29vZ2xlIEhvdyBSIHlvdT8KCkknbSBmaW5l"    }

    Example - Upload a file to the repository

    1. In theConfigure connector task dialog, clickActions.
    2. Select theUploadFile action, and then clickDone.
    3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
            {    "Path": "Sample.txt",    "Repository": "Google_GitHub_Testing",    "AuthorName": "Cruz",    "FileData": "dXBsb2FkIGR0YWEgaW50byB0aGlzIGZpbGUgZnJvbSBHQ1A=",    "CommitMessage": "TestCommitFrom GCPcloud",    "CommitterEmail": "Charlie@altrostrat.com",    "CommitterName": "Charlie",    "AuthorEmail": "cruz@altrostrat.com"      }

      4. If the action is successful, theUploadFile task'sconnectorOutputPayload response parameter will have a value similar to the following:

          {      "Success": false,      "Details": "Invalid request.\n\n\"sha\" wasn't supplied. ",      "CommitSHA": null,      "FileSHA": null    }

    Entity operation examples

    This section shows how to perform some of the entity operations in this connector.

    Example - List all Branches

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectBranches from theEntity list.
    3. Select theList operation, and then clickDone.
    4. In theTask Input section of theConnectors task, you can set thefilterClause as per your requirement.

    Example - List all Commits

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectCommits from theEntity list.
    3. Select theList operation, and then clickDone.
    4. In theTask Input section of theConnectors task, you can set thefilterClause as per your requirement.

    Considerations

    • Commits is the name of the entity. You must pass the value for filter clause using single quotes ('), such as City='Redwood City'. Where City is the column name and Redwood city is the value.
    • You can make use of the filter clause to filter records based on columns. For example, if there are 20 records withname = demo16975280986860 then we can filter records with column Address='Redwood City' and region='us-east1'.

    You can perform the List operation on the following entities:

    CommitComments, Forks, IssueComments, Issue, IssueAssignees, AssignableUser,Labels, Milestones, PullRequestReviews, PullRequests, PullRequestComments, ReleaseAssets, Releases, Watcher, Users, Repositories, Collaborators, OrganizationTeams, OrganizationsMannequins, OrganizationMember, Organization, Licenses, LicensePermission, LicenseLimitation, LicenseConditions, Projects, and PullRequestReviewRequests

    Example - Get a Branches record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectBranches from theEntity list.
    3. Select theGet operation, and then clickDone.
    4. Here, the entity ID is set to 4. To set the entity ID, intheTask Input section of theConnectors task, clickEntityId andthen enter4 in theDefault Value field.

    Example - Get a Repositories record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectRepositories from theEntity list.
    3. Select theGet operation, and then clickDone.
    4. Set the entity ID to 4 which is the Key to be passed. To set the entity ID, intheTask Input section of theConnectors task, clickEntityId andthen enter4 in theDefault Value field.

      5. In some cases passing a single Entity ID can cause an error because of two composite keys. In such cases, use the filter clause with the necessary columns.

      For views, the Get operation doesn't work because views don't have primary keys. Instead, you can use the List operation with filters on views, which functions similarly to the Get operation.

    You can perform the Get operation on the following entities:

    CommitComments, Commits, IssueAssignees, Labels, Milestones, PullRequestReviews, PullRequests, PullRequestComments, ReleaseAssets, Release, Topics, Users, Collaborators, Organizations, and Licenses

    Example - Create an Issues record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectIssues from theEntity list.
    3. Select theCreate operation, and then clickDone.
    4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
           {  "Title": "Google_Cloud_GitHub_Issues_Create",  "Body": "Please check hence raising the Feature Request for the same."     }

      Running this example, returns a response smiliar to the following in the Connectortask'sconnectorOutputPayload output variable:

           {  "Id": "I_kwDOLywhW86Sd-xF"     }

    Example - Create a PullRequests record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectPullRequests from theEntity list.
    3. Select theCreate operation, and then clickDone.
    4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
           {  "BaseRefName": "main",  "HeadRefName": "New_Branch",  "Title": "DEMO_Google_Cloud_PULLRequest",  "Body": "This is demo Google_Cloud pull"     }

      Running this example, returns a response smiliar to the following in the Connectortask'sconnectorOutputPayload output variable:

            {  "Id": "PR_kwDOLywhW8537gcA"      }

    Example - Create a Repositories record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectRepositories from theEntity list.
    3. Select theCreate operation, and then clickDone.
    4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
           {  "Name": "Google_Cloud_DEMO_REPO",  "OwnerId": "O_kgDOCaxLsg",  "Visibility": "PUBLIC"     }

      Running this example, returns a response smiliar to the following in the Connectortask'sconnectorOutputPayload output variable:

            {  "Id": "R_kgDOMhWBEQ"      }

    Example - Update an Issues record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectIssues from theEntity list.
    3. Select theUpdate operation, and then clickDone.
    4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
           {  "Title": "New_Updated_Google_Cloud_Issue",  "Body": "Newly Updated from Google_Cloud"     }
    5. Set the value for entityId to I_kwDOLywhW86Sd-xF. To set the value for filterClause,clickentityId and then enterI_kwDOLywhW86Sd-xF in theDefault Valuefield.

      Running this example, returns a response smiliar to the following in the Connectortask'sconnectorOutputPayload output variable:

           {  "Id": "I_kwDOLywhW86Sd-xF"     }

    Example - Update a PullRequests record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectPullRequests from theEntity list.
    3. Select theUpdate operation, and then clickDone.
    4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
            {  "Title": "Updated_Google_Cloud_PULL",  "Body": "Update New pull Body"      }
    5. Set the value for entityId to PR_kwDOLywhW8537gcA. To set the value for filterClause,clickentityId and then enterPR_kwDOLywhW8537gcA in theDefault Valuefield.

      Running this example, returns a response smiliar to the following in the Connectortask'sconnectorOutputPayload output variable:

            {  "Id": "PR_kwDOLywhW8537gcA"      }

    Example - Update a Repositories record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectRepositories from theEntity list.
    3. Select theUpdate operation, and then clickDone.
    4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:
            {  "Name": "Updated_New_Google_Cloud_Repo"      }
    5. Set the value for entityId to R_kgDOMhWBEQ. To set the value for filterClause,clickentityId and then enterR_kgDOMhWBEQ in theDefault Valuefield.

      Running this example, returns a response smiliar to the following in the Connectortask'sconnectorOutputPayload output variable:

            {  "Id": "R_kgDOMhWBEQ"      }

    Example - Delete a PullRequestReviewRequests record

    1. In theConfigure connector task dialog, clickEntities.
    2. SelectPullRequestReviewRequests from theEntity list.
    3. Select theDelete operation, and then clickDone.
    4. Set the value for filterClause,clickfilterClause and then enterPullRequestId= 'PR_kwDOLywhW85yNWPa' and RequestedReviewerUserId= 'U_kgDOCebPLA' in theDefault Valuefield.

      5. In this example, PullRequestReviewRequests is name of the table and the value for filterClause should be passed directly.
      Such as, PullRequestId= 'PR_kwDOLywhW85yNWPa' and RequestedReviewerUserId= 'U_kgDOCebPLA'.
      Here, PullRequestId= 'PR_kwDOLywhW85yNWPa' and RequestedReviewerUserId= 'U_kgDOCebPLA' are the unique primary key values that should be passed.

    Use the GitHub connection in an integration

    After you create the connection, it becomes available in bothApigee Integration and Application Integration. You can use the connectionin an integration through the Connectors task.

    • To understand how to create and use the Connectors task in Apigee Integration, seeConnectors task.
    • To understand how to create and use the Connectors task in Application Integration, seeConnectors task.

    Get help from the Google Cloud community

    You can post your questions and discuss this connector in the Google Cloudcommunity atCloud Forums.

    What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.