Set up the Gmail spoke

  • Release version: Zurich
  • Updated August 3, 2023
  • 2 minutes to read
  • Set up an outbound integration between the ServiceNow instance and the Google APIs.

    Before you begin

    • Request an Integration Hub subscription.
    • Install the Gmail spoke plugin on the ServiceNow instance.
    • Role required: admin.

    About this task

    To establish an outbound integration, you must complete these steps.

    Set up an OAuth 2.0 client ID

    Create a custom OAuth application to enable OAuth 2.0 authentication of the ServiceNow by the Google APIs.

    Before you begin

    Google Tasks integration requirements:
    • A domain and an email address associated with the domain. For example, www.mydomain.com and jane-admin@mydomain.com. You can only register one email address per domain in G Suite.
    • A Google G Suite or Gmail login created with the domain.

    Role required: admin.

    Procedure

    1. Navigate to https://console.developers.google.com, create a project with your G Suite administrator credentials, and open the project.
    2. From the APIs & Services menu, select OAuth consent screen.
    3. Enter the application name, and specify the Authorized domain service-now.com.
    4. Click Save.
    5. From the APIs & Services menu, select Credentials, and select Create OAuth client ID from the Create credentials list.
    6. Select the application type Web application.
    7. Enter the following Authorized redirect URI: https://<instance>.service-now.com/oauth_redirect.do and select Create.
    8. Copy the Client ID and the Client Secret to a text file.

    Configure a connection for the Gmail spoke

    Configure the Gmail connection record to establish a connection between the ServiceNow instance and the Google APIs.

    Before you begin

    Role required: admin.

    About this task

    The connection and credentials contain the details such as the client ID, client secret, and the redirect URL that the Google Workspace must authenticate the ServiceNow instance.

    Procedure

    1. Navigate to All > Process Automation > Workflow Studio.
    2. Select the Integrations tab.
    3. Select the Connections tab.
    4. In the Search all connections field, enter Gmail.
    5. Select View Details.
      View Details button on Gmail spoke connection alias.
    6. Select Configure.
      Configure button on Gmail spoke connection alias.
    7. Fill the form with the details given in the table.
      Table 1. Configure connection form
      Field Description
      Connection Name Name of the connection between the Google Workspace and the ServiceNow instance.
      Note:
      The default name is Gmail and it's read-only. However, you can provide custom names when you set up more connection and credential records after this record.
      Connection URL Enter the URL https://www.googleapis.com
      Note:
      Make sure that you don't include spaces before or after this URL. If there are spaces, the connection fails.
      .
      OAuth Entity Name Name to identity the OAuth entity record.
      OAuth Client ID The OAuth client ID generated when you created the OAuth client ID.
      OAuth Client Secret The OAuth client secret generated when you created the OAuth client ID.
      OAuth Redirect URL The OAuth redirect URL. It must be in the format: https://<instance-name>.service-now.com/oauth_redirect.do.
      Gmail connection form.
    8. Select Configure and Get OAuth Token.
      You must log into Gmail after the OAuth token is issued.