Set up the Gmail spoke

task australia Updated Aug 3, 2023 2 min read setup-gmail.md
Raw file servicenow.com

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. Click the Integrations tab.

  3. Under Connections, toggle and enable the Outbound connections.

  4. Locate the alias for Gmail and click View Details.

    [Omitted image "gmail-spk-conn-alias.png"] Alt text: View Details button on Gmail spoke connection alias.

    To manage more than one Gmail connection record, create a new child alias record by selecting Add Connection. For more information about using multiple connections, see Supporting multiple connections.

    If you are configuring the spoke for the first time, click Configure. Otherwise, click Edit.

    [Omitted image "gmail-spk-alias-config-button.png"] Alt text: Configure button on Gmail spoke connection alias.

  5. On the form, fill in these fields:

Field

Description

Connection Information

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.comNote: Make sure that you don't include spaces before or after this URL. If there are spaces, the connection fails.

.

Credential Information

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.

\[Omitted image "gmail-spk-conn-form.png"\] Alt text: Gmail connection form.
  1. Click Save and Get OAuth Token.

    You must log into Gmail after the OAuth token is issued.

Search documentation
Search document titles and file paths on the australia branch