See the supported connectors for Application Integration.

Cloud Pub/Sub trigger

The Cloud Pub/Sub trigger lets you run your integration based on the events in your Pub/Sub middleware.

Using this trigger, you can execute an integration whenever a publisher writes a message to your chosen topic. The topic can exist in the same Google Cloud project as the integration, or in a different Google Cloud project. When this trigger executes, it also writes the published message to the CloudPubSubMessage output variable. Based on your requirements, you can use this variable in your downstream triggers or tasks.

Before you begin

Ensure that you perform the following tasks in your Google Cloud project before configuring the Cloud Pub/Sub trigger.

• Assign the Project IAM Admin (roles/resourcemanager.projectIamAdmin) to the user creating this trigger.
• Enable the Pub/Sub API for the Google Cloud project that has your integration.
• Confirm that you have a Pub/Sub topic. To create a new Pub/Sub topic:
  1. Go to the Pub/Sub topics page in the Cloud console.

     Go to the Pub/Sub topics page

  2. Click Create a topic.
  3. In the Topic ID field, provide a unique topic name.
  4. Click Save.
  Note: You don't have to create a subscription for the trigger to work. Application Integration automatically creates a subscription for a topic, and you can view all your subscriptions in the Pub/Sub subscription page.

  Starting with the Application Integration December 01 2023 release, you will be billed for your subscriptions as per the Pub/Sub billing rates. Subscriptions for your existing Cloud Pub/Sub trigger will continue to work as before, and they aren't billed. However, if you update the topic of an existing Cloud Pub/Sub trigger, Pub/Sub billing will be applied to the updated Cloud Pub/Sub trigger.

For more information about managing access using IAM roles, see Access control.

For information on granting roles to principals, see Granting, changing, and revoking access.

Add a Cloud Pub/Sub trigger

To add a Cloud Pub/Sub trigger to a new or existing integration, follow the steps below:

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

   Go to Application Integration

2. In the navigation menu, click Integrations

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

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

   If you are creating a new integration:

   1. Enter a name and description in the Create Integration pane.
   2. Select a region for the integration.
      Note: The Regions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, Click Enable Region. See Enable 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 the Integration 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. Click Create.

   This opens the integration in the integration editor.

4. In the integration editor navigation bar, click Triggers to view the list of available triggers.
5. Click and place the Cloud Pub/Sub trigger element to the designer.

Configure a Cloud Pub/Sub trigger

Click the Cloud Pub/Sub trigger element in the integration editor to view the trigger configuration pane, and then do the following tasks:

1. Specify the topic the trigger should listen to in the Pub/Sub topic field in the following format:

   projects/PROJECT_ID/topics/TOPIC_ID

   To view all the available topics in your Google Cloud project, see the Topic name column in Topics.

   Replace the following:
   • PROJECT_ID: the Google Cloud project where your topic is created.
   • TOPIC_ID: the ID of your Pub/Sub topic. The topic can be in the same Google Cloud project as that of your integration, or can be present in a different Google Cloud project.
2. Select the service account that you want to use for the trigger. Selecting a service account, prompts you to grant the required roles. For more information, see Required IAM roles.

   If there are no service accounts, create a service account by clicking Create new in the Service account drop-down.

   Note: Starting with the Application Integration December 01 2023 release, when you configure the Cloud Pub/Sub trigger, you must specify a service account for the trigger. Your existing Pub/Sub triggers, that don't have any service account associated with them, will continue to work as before. However, if you want to modify any of the existing Pub/Sub triggers, you must configure a service account to continue using those triggers.

IAM roles required for service accounts

Clicking Grant when selecting a service account, automatically provides the following roles to the various service accounts.

Service account	IAM role granted
Application Integration's default service account: [e-mail]	Pub/Sub Editor (roles/pubsub.editor) Service Account User (roles/iam.serviceAccountUser) If the Pub/Sub topic's Google Cloud project is different from the integration's Google Cloud project, the default service account needs Pub/Sub Editor role in the topic's Google Cloud project.
Service account that you select for this trigger	Application Integration Invoker (roles/integrations.integrationInvoker)

Trigger Output

For each event, the Cloud Pub/Sub trigger generates a CloudPubSubMessage output variable which you can use in your downstream tasks. The variable is in JSON format and has the PubsubMessage structure.

Considerations

• The maximum size of a Pub/Sub message is 10 MB. To understand all the limitations of Pub/Sub, see Pub/Sub quotas and limits.
• It is possible that Pub/Sub writes the same message more than once to a topic. To understand this behavior of Pub/Sub, see At-Least-Once delivery. Therefore, you must design your integration to be idempotent so that it doesn't allow a message to be written more than once to a topic.
  Note: The message_id field in the message header uniquely identifies a Pub/Sub message.
• If you unpublish an integration, the Pub/Sub subscription is not deleted to prevent loss of messages. However, if you delete the published version or all the integration versions of an integration, then the Pub/Sub subscription is also deleted.

Create subscription with filter for your integration

If you want to set a filter for the Pub/Sub subscription to process specific events in your integration, follow these steps:

1. Publish the integration with the Cloud Pub/Sub trigger configured. This step creates the subscription in the integration project.
2. In the Google Cloud console, go to the Subscriptions page.

   Go to Subscriptions

3. Open the subscription and copy all the details including the subscription name.
4. Delete the existing subscription.
5. Create a new subscription with all the details of the deleted subscription–including the subscription name–that you copied in step 3 and also add a filter in the new subscription.

   The newly created subscription triggers the integration with filtered messages.

SLA exclusions

The Cloud Pub/Sub trigger is dependent on the Pub/Sub product. As this dependency is external to the Application Integration, the Application Integration Service Level Agreement (SLA) terms and conditions are applicable only when the Cloud Pub/Sub trigger successfully starts the execution of an active integration.