ServiceNow trigger

TheServiceNow trigger is aConnector Event trigger that lets you invoke an integration based on the custom ServiceNow events that you've defined in your ServiceNow instancebusiness rule.

Important: Integration Connectors is a billable component of Google Cloud. For information about the costs and charges of using Integration Connectors, seeIntegration Connectors pricing.

Before you begin

If you plan to create or configure a new connection for theServiceNow trigger, make sure that you have the following IAM role on the project:

• Connector Admin (roles/connectors.admin)

For information about granting roles, seeManage access.

Grant the following IAM roles to the service account that you want to use for theServiceNow trigger:

• Application Integration Invoker (roles/integrations.integrationInvoker)

For information about granting roles to a service account, seeManage access to service accounts.

Add the ServiceNow trigger

To add aServiceNow trigger to your integration, perform the following steps:

1. In the Google Cloud console, go to theApplication Integration page.

   Go to Application Integration

2. In the navigation menu, clickIntegrations

   TheIntegrations List page appears listing all the integrations available in the Google Cloud project.

3. Select an existing integration or clickCreate integration to create a new one.

   If you are creating a new integration:

   1. Enter a name and description in theCreate Integration pane.
   2. Select a region for the integration.Note: TheRegions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, ClickEnable Region. SeeEnable new region for more information.
   3. Select a service account for the integration. You can change or update the service account details of an integration any time from theinfoIntegration summary pane in the integration toolbar.Note: The option to select a service account is displayed only if you have enabled integration governance for the selected region.
   4. ClickCreate.

   The newly created integration opens in theintegration editor.

4. In theintegration editor navigation bar, clickTriggers to view the list of available triggers.
5. Click and place theServiceNow trigger element in the integration editor.

To configure theServiceNow trigger, you can either use an existing ServiceNow connection available in Integration Connectors, or create a new ServiceNow connection using the inline connection creation option.

Configure ServiceNow trigger using an existing connection

You can configure theServiceNow trigger using an existing ServiceNow connection in Integration Connectors. Note that theServiceNow trigger is anConnector Event trigger, therefore you can only use a ServiceNow connection with event subscription enabled to configure the trigger.

For information about how to configure aServiceNow trigger using a new ServiceNow connection, SeeConfigure ServiceNow trigger using a new connection

To configure aServiceNow trigger using an existing ServiceNow connection, perform the following steps:

1. Click theServiceNow trigger element in the integration editor to open the trigger configuration pane.
2. ClickConfigure trigger.
3. Provide the following configuration details in theConnector Event Trigger Editor page:
   1. Region: Select the region of your ServiceNow connection.
   2. Connection: Select the ServiceNow connection that you want to use.

      Application Integration only displays those ServiceNow connections that are active and have anevent subscription enabled.

   3. Event subscription type: Enter the type of event that you want to use to trigger the integration. These event types must be defined in your ServiceNow instancebusiness rule.
   4. Service Account: Select a service account with therequired IAM roles for the ServiceNow trigger.
4. ClickDone to complete the trigger configuration and close the page.

Configure ServiceNow trigger using a new connection

To configure theServiceNow trigger using a new ServiceNow connection, perform the following steps:

1. Click theServiceNow trigger element in the integration editor to open the trigger configuration pane.
2. ClickConfigure trigger.
3. Skip theRegion field.
4. ClickConnection and select theCreate Connection option from the drop-down menu.
5. Complete the following steps in theCreate Connection pane:
   1. In theLocation step, choose the location for the new ServiceNow connection:
      1. Region: Select a region from the drop-down list.
      2. ClickNext.
   2. In theConnection Details step, provide details about the new ServiceNow connection:
      1. Connector version: Choose an available version of the ServiceNow connector from the drop-down list.
      2. Connection Name: Enter a name for the ServiceNow connection.Note: 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 63 characters.
      3. (Optional)Description: Enter a description for the connection.
      4. (Optional)Enable Cloud Logging: Select this checkbox to store all log data of the connection.
      5. Service Account: Select a service account with therequired IAM roles for the ServiceNow connection.
      6. Enable event subscription: Select to create and enable a new event subscription for the ServiceNow connection. You can either only enable event subscriptions or also include connectionentities, operations, and actions.Note: The following additional connection configuration steps are required if you choose to enableentities, operations, and actions for the connection:
         • Destinations
         • Authentication
      7. Include system tables: Select to report or include system tables in the connection.
      8. (Optional)Filter tables: Enter the list of system tables (beginning with "sys_", comma separated), that you want to include.
      9. (Optional) ExpandAdvanced settings to configure the connection node settings.

         For more information about the connection node settings for ServiceNow, see theServiceNow connection documentation.

      10. (Optional) Click+ Add label to add a label to the connection in the form of a key-value pair.
      11. ClickNext.
   3. In theDestinations step, provide the ServiceNow instance details:
      1. Destination Type: SelectHost address.
      2. Host: Enter the hostname or IP address of your ServiceNow instance.
      3. ClickNext.
   4. In theAuthentication step, provide the authentication details for the ServiceNow instance:
      1. Username: Enter the username to access the provided destination address.
      2. Password: Select the Secret Manager secret containing the password associated with the ServiceNow username.
      3. Secret version: Select a secret version.

      To know more about how to configure authentication, seeConfigure authentication.

      4. ClickNext.
   5. In theEvent subscription details step, provide the authentication details that will be used to validate the ServiceNow token payload:
      1. Authentication Token: (Optional) Select the Secret Manager secret of your authentication token, and the corresponding secret version from theSecret Version drop-down.
      2. HMAC Algorithm: (Optional) Select the HMAC algorithm for encrypting the response payload.
      3. HMAC Secret Key: If you have selected aHMAC Algorithm, select the Secret Manager secret of the HMAC key, and the corresponding secret version from theSecret Version drop-down.
      4. ClickNext.
   6. Review: Review the provided ServiceNow connection details.
   7. ClickCreate to complete creating a new ServiceNow connection.
6. Once the ServiceNow connection is created, you must go to your ServiceNow instance and manually create a business rule.Note: ServiceNow doesn't auto-create a business rule. Therefore you must manually create a business rule in your ServiceNow instance to enable event subscriptions. For information on how to create a business rule, seeCreate a business rule.
7. Event subscription type: Enter the type of event that you want to use to trigger the integration. These event types must be defined in your ServiceNow instancebusiness rule.
8. ClickDone and close the page.

Create a business rule

A ServiceNow business rule is a server-side logic that executes when a database record is queried, updated, inserted, or deleted in your ServiceNow instance. Application Integration uses these business rules to identify and listen to events that trigger an integration.

For information on how to create a business rule, seeServiceNow documentation.

Key Points:

• Use theEvents listener endpoint value from your ServiceNow connection in Integration Connectors to define therequest.setEndpoint URL in your business rule.
• UseeventType as thekey to define custom event typesvalues inrequest.setRequestBody.

The following image shows a sample ServiceNow business rule with theupdate_ticket event type:

Trigger output

TheServiceNow trigger takes a couple of minutes to complete the event subscription configuration. You can view the status of your event subscription in the trigger configuration pane underEvent Subscription details.

TheServiceNow trigger indicates the status of an event subscription using the following states:

• restart_altCreating: Indicates that the trigger is subscribing to the event subscription.
• check_circleActive: Indicates that the trigger is successfully subscribed to an event subscription.
• errorError: Indicates that the there is an issue with the configured event subscription.

In addition to the event subscription status, theEvent Subscription details section also displays other details such as connection region, connection name, event subscription name, and more.

The following image shows a sample layout of the ServiceNow trigger configuration pane:

Trigger output variable

For each event, theServiceNow trigger generates aConnectorEventPayload output variable which you can use in your downstream tasks. The output variable is in JSON format containing the output ServiceNow payload schema.

View event subscriptions

To view and manage all the event subscriptions associated with a connection in Integration Connectors, do the following:

1. Go toIntegration Connectors > Connections page.

   Go to the Connections page

2. Click the connection for which you want to view the subscriptions.
3. Click theEvent subscriptions tab.

   This displays all the event subscriptions for the connection.

Edit ServiceNow trigger

You can edit aServiceNow trigger to change or update the connection configuration and event subscription details.

Important: When you edit or modify a ServiceNow trigger, you can either retain the previously configured event subscription that is attached to the trigger, or you can delete it. Deleting an event subscription will affect all the published integrations using that event subscription.

To edit a ServiceNow trigger, perform the following steps:

1. Click theServiceNow trigger element in the integration editor to open the trigger configuration pane.
2. ClickConfigure ServiceNow trigger.
3. Do the following in theConnector Event Trigger Editor page:
   1. To retain the previously configured event subscription, clickRetain, else clickDelete.Warning: Deleting an event subscription will affect all the published integrations using the event subscription. This task cannot be undone.
   2. Update the connection configuration and event subscription details as desired.
   3. ClickDone.

You can view the updated connection and event subscription details in the trigger configuration pane underEvent Subscription details.

Quotas and limits

For information about quotas and limits, seeQuotas and limits.

What's next

• Learn aboutall tasks and triggers.
• Learn how totest and publish an integration.
• Learn abouterror handling.
• Learn aboutintegration execution logs.