> [!WARNING]
>
> **Preview
> --- Firebase Realtime Database direct events**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

An Eventarc trigger declares your interest in a certain event or set
of events. You can configure event routing by specifying filters for the trigger,
including the event source, and the target Cloud Run service.

Eventarc delivers events to the event receiver in a
[CloudEvents format](https://docs.cloud.google.com/eventarc/docs/cloudevents.md.txt) through an HTTP request.

These instructions show you how to configure event routing to your
Cloud Run service that is triggered by a direct
Firebase Realtime Database event. For more details, see the list of
[supported direct events](https://docs.cloud.google.com/eventarc/docs/reference/supported-events.md.txt#directly-from-a-google-cloud-source).

> [!NOTE]
> **Note:** If both direct and audit log events are supported for a Google provider, we recommend that you create a trigger that filters for the direct event. Direct events offer a number of advantages over audit log events. For more information, see [Event routes](https://docs.cloud.google.com/eventarc/standard/docs/run/event-routing-options.md.txt).

## Prepare to create a trigger

Before you create a trigger, complete these prerequisites:

### Console

1. In the Google Cloud console, on the project selector page, select or
   [create a Google Cloud project](https://docs.cloud.google.com/resource-manager/docs/creating-managing-projects.md.txt).

   > [!NOTE]
   > **Note:** If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.


   [Go to project selector](https://console.cloud.google.com/projectselector2/home/dashboard)

   <br />

2. Enable the Cloud Logging, Eventarc, and
   Eventarc Publishing APIs.

   [Enable the APIs](https://console.cloud.google.com/apis/enableflow?apiid=eventarc.googleapis.com,eventarcpublishing.googleapis.com,logging.googleapis.com)

   <br />

3. If applicable, enable the API related to the direct events. For example,
   for Firebase Realtime Database events, enable the
   Firebase Realtime Database API.

4. If you don't already have one, create a user-managed service account,
   then grant it the roles and permissions necessary so that
   Eventarc can manage events for your target service.

   1. In the Google Cloud console, go to the **Create service account**
      page.


      [Go to Create service account](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts/create?supportedpurview=project)

      <br />

   2. Select your project.

   3. In the **Service account name** field, enter a name. The Google Cloud console
      fills in the **Service account ID** field based on this name.

      In the **Service account description** field, enter a description. For
      example, `Service account for event trigger`.
   4. Click **Create and continue**.

   5. To provide appropriate access, in the **Select a role** list, select
      the required Identity and Access Management (IAM) roles to grant to your service
      account for authenticated or unauthenticated invocations. For more
      information, see
      [Roles and permissions for Cloud Run targets](https://docs.cloud.google.com/eventarc/docs/roles-permissions.md.txt).

      For additional roles, click
      **Add another role** and add each additional role.

      > [!IMPORTANT]
      > **Important:** To accept authenticated invocations to your Cloud Run service, you must associate your trigger with a service account that has the `roles/run.invoker` role. When creating or updating your trigger, select that service account.

   6. Click **Continue**.

   7. To finish creating the account, click **Done**.

### gcloud

1.


   In the Google Cloud console, activate Cloud Shell.

   [Activate Cloud Shell](https://console.cloud.google.com/?cloudshell=true)


   At the bottom of the Google Cloud console, a
   [Cloud Shell](https://docs.cloud.google.com/shell/docs/how-cloud-shell-works.md.txt)
   session starts and displays a command-line prompt. Cloud Shell is a shell environment
   with the Google Cloud CLI
   already installed and with values already set for
   your current project. It can take a few seconds for the session to initialize.

   <br />

2. Enable the Cloud Logging, Eventarc, and
   Eventarc Publishing APIs.

   ```bash
   gcloud services enable logging.googleapis.com \
     eventarc.googleapis.com \
     eventarcpublishing.googleapis.com
   ```

   <br />

3. If applicable, enable the API related to the direct events. For example,
   for Firebase Realtime Database events, enable
   `firebasedatabase.googleapis.com`.

4. If you don't already have one, create a user-managed service account,
   then grant it the roles and permissions necessary so that
   Eventarc can manage events for your target service.

   1. Create the service account:

      ```bash
      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
      ```

      Replace `SERVICE_ACCOUNT_NAME` with the name of
      the service account. It must be between 6 and 30 characters, and can
      contain lowercase alphanumeric characters and dashes. After you create
      a service account, you cannot change its name.
   2. Grant the required Identity and Access Management (IAM) roles or permissions
      for authenticated or unauthenticated invocations. For more information,
      see
      [Roles and permissions for Cloud Run targets](https://docs.cloud.google.com/eventarc/docs/roles-permissions.md.txt).

   > [!IMPORTANT]
   > **Important:** To accept authenticated invocations to your Cloud Run service, you must associate your trigger with a service account that has the `roles/run.invoker` role. When creating or editing your trigger, use the `--service-account` flag to associate that service account with the trigger.

## Create a trigger

You can create an Eventarc trigger using the Google Cloud CLI
or through the Google Cloud console.


> [!NOTE]
> **Note:** Filtering is done through an exact match and does not support wildcards or regular expressions. However, you can use the `--event-filters-path-pattern` flag in the following gcloud CLI command, or define a path pattern through the console. For more information, see [Understand path patterns](https://docs.cloud.google.com/eventarc/docs/path-patterns.md.txt).

<br />

### Console

1. In the Google Cloud console, go to the Eventarc **Triggers** page.

   [Go to Triggers](https://console.cloud.google.com/eventarc/triggers)
2. Click **Create trigger**.
3. Type a **Trigger name** .

   This is the ID of the trigger and it must start with a letter. It can
   contain up to 63 lowercase letters, numbers, or hyphens.
4. For the **Trigger type** , select **Google sources**.
5. In the **Event provider** list, select **Firebase Realtime Database** .

   Note that the event provider name used in the associated
   [Google Cloud documentation](https://docs.cloud.google.com/docs) might not have a prefix
   of *Cloud* or *Google Cloud* . For example, on the console,
   *Memorystore for Redis* is referred to as
   **Google Cloud Memorystore for Redis**.
6. In the **Event type** list, from the *Direct* events, select an event type.
7. In the **Event data content type** list, select the encoding of the event payload.

   For direct events from Firebase Realtime Database,
   this must be **application/json**.
8. In the **Region** list, select the same region as the Google Cloud service that is generating events.

   For more information, see
   [Eventarc locations](https://docs.cloud.google.com/eventarc/docs/locations.md.txt).
9. In the **Attribute 1** field, the **instance** [resource ID](https://docs.cloud.google.com/apis/design/resource_names) acts as an event filter. Select an operator for this filter:
   - **Equal**
   - **Path pattern**

     For more information, see
     [Understand path patterns](https://docs.cloud.google.com/eventarc/docs/path-patterns.md.txt).
10. In the **Attribute value 1** field, enter the name of the database instance to receive events from. Depending on the operator that you chose in the previous step, the attribute value should be the exact name or a path pattern format.
11. For the **ref** attribute, select the **Path pattern** operator.
12. In the **Attribute value 2** field, enter the database instance path to receive events from if data is created, updated, or deleted in that path or any child path.
13. Select the **Service account** that will invoke your service or workflow.

    Or, you can create a new service account.

    This specifies the Identity and Access Management (IAM) service account email
    associated with the trigger and to which you previously granted
    [specific roles](https://docs.cloud.google.com/eventarc/standard/docs/access-control.md.txt) required
    by Eventarc.
14. In the **Event destination** list, select **Cloud Run**.
15. Select a service.  

    This is the name of the service that receives the events for the trigger.
    The service must be in the same project as the trigger and will receive
    events as HTTP POST requests sent to its root URL path (`/`),
    whenever the event is generated.
16. Optionally, you can specify the **Service URL path** to send the incoming request to.

    This is the relative path on the destination service to which the events
    for the trigger should be sent. For example: `/`, `/route`,
    `route`, `route/subroute`.
17. Optionally, to specify a single delivery attempt with no retries, clear the **Enable retry on failure** checkbox; otherwise, the default behavior is retries if the delivery attempt fails. For more information, see [Retry events](https://docs.cloud.google.com/eventarc/docs/retry-events.md.txt).
18. Optionally, to add a label, you can click **Add label** . Labels are key-value pairs that help you organize your Google Cloud resources. For more information, see [What are labels?](https://docs.cloud.google.com/resource-manager/docs/labels-overview.md.txt#what-are-labels)
19. Click **Create**.
20. After a trigger is created, the event source filters can't be modified. Instead, create a new trigger and delete the old one. For more information, see [Manage triggers](https://docs.cloud.google.com/eventarc/docs/managing-triggers.md.txt).

### gcloud

You can create a trigger by running
[`gcloud eventarc triggers create`](https://docs.cloud.google.com/sdk/gcloud/reference/eventarc/triggers/create)
along with required and optional flags.

```bash
gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="instance=INSTANCE" \
    --event-filters-path-pattern="ref=REF" \
    --max-retry-attempts=1 \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"
```

Replace the following:

- `TRIGGER`: the ID of the trigger or a fully qualified identifier.

<!-- -->

- `LOCATION`: the location of the Eventarc trigger. Alternatively, you can set
  the `eventarc/location` property; for example
  `gcloud config set eventarc/location us-central1`.

  Firebase Realtime Database triggers for Eventarc are only
  available in certain locations and the trigger must be in the same
  location as the Firebase Realtime Database instance. For more information,
  see [Eventarc locations](https://docs.cloud.google.com/eventarc/docs/locations.md.txt) and
  [Realtime Database locations](https://firebase.google.com/docs/projects/locations#rtdb-locations).

- `DESTINATION_RUN_SERVICE`: the name of the Cloud Run service that receives the events for the trigger. The service can be in any of the Cloud Run supported locations and doesn't need to be in the same location as the trigger. However, the service must be in the same project as the trigger and will receive events as HTTP POST requests sent to its root URL path (`/`), whenever the event is generated.
- `DESTINATION_RUN_REGION`: (optional) the [Cloud Run location](https://docs.cloud.google.com/run/docs/locations.md.txt) in which the destination Cloud Run service can be found. If not specified, it is assumed that the service is in the same region as the trigger.
- `EVENT_FILTER_TYPE`: the identifier of the
  Firebase Realtime Database event and can be one of the following:

  - `google.firebase.database.ref.v1.created`: event is sent when data is created in the database
  - `google.firebase.database.ref.v1.updated`: event is sent when data is updated in the database
  - `google.firebase.database.ref.v1.deleted`: event is sent when data is deleted in the database
  - `google.firebase.database.ref.v1.written`: event is sent when data is created, updated, or deleted in the database
- `INSTANCE`: a single database instance and the
  operator can be one of the following:

  - Equal; for example, `--event-filters="instance=INSTANCE"`
  - Path pattern; for example, `--event-filters-path-pattern="instance=INSTANCE"`. For more information, see [Understand path patterns](https://docs.cloud.google.com/eventarc/docs/path-patterns.md.txt).
- `REF`: the path within the database instance for
  which you want to receive events from when data is created, updated,
  or deleted in that path, or any of its children.

- `SERVICE_ACCOUNT_NAME`: the name of your user-managed service account.
- `PROJECT_ID`: your Google Cloud project ID.

Notes:

- For direct events from Firebase Realtime Database, the encoding of the event payload is `application/json`.
- These flags are required:
  - `--event-filters="type=EVENT_FILTER_TYPE"`
  - `--event-filters="instance=INSTANCE"` or `--event-filters-path-pattern="instance=INSTANCE"`
  - `--event-filters-path-pattern="ref=REF"`
- After a trigger is created, the event filter type can't be changed. For a different event type, you must create a new trigger.
- Optionally, to specify a single event delivery attempt with no retries, use the `--max-retry-attempts` flag. The only valid value is `1`. If you omit the flag, the standard retry behavior applies. For more information, see [Retry events](https://docs.cloud.google.com/eventarc/docs/retry-events.md.txt).
- The `--service-account` flag is used to specify the Identity and Access Management (IAM) service account email associated with the trigger.
- Optionally, to specify a relative path on the destination Cloud Run service to which the events for the trigger should be sent, use the `--destination-run-path` flag.

Example:

```sh
gcloud eventarc triggers create helloworld-trigger \
    --location=us-central1 \
    --destination-run-service=helloworld-events \
    --destination-run-region=us-central1 \
    --event-filters="type=google.firebase.database.ref.v1.created" \
    --event-filters="instance=test-instance" \
    --event-filters-path-pattern="ref=users/*" \
    --service-account=${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com
```

This command creates a trigger called `helloworld-trigger` for the event
identified as `google.firebase.database.ref.v1.created` and for the
`users/*` path within the database instance identified as `test-instance`.

### Terraform


You can create a trigger for a Cloud Run destination using
Terraform. For details, see
[Create a trigger using Terraform](https://docs.cloud.google.com/eventarc/docs/creating-triggers-terraform.md.txt).

> [!NOTE]
> **Note:** Although your trigger is created immediately, it can take up to two minutes for a trigger to propagate and filter events.

## List a trigger

You can confirm the creation of a trigger by listing Eventarc
triggers using the Google Cloud CLI or through the Google Cloud console.

### Console

1. In the Google Cloud console, go to the Eventarc
   **Triggers** page.


   [Go to Triggers](https://console.cloud.google.com/eventarc/triggers)

   <br />

   This page lists your triggers in all locations, and includes details such
   as names, regions, event providers, destinations, and more.
2. To filter your triggers:

   1. Click **Filter** or the **Filter triggers** field.
   2. In the **Properties** list, select an option to filter the triggers by.

   You can select a single property or use the logical operator `OR` to add
   more properties.
3. To sort your triggers, beside any supported column heading, click
   **Sort**.

### gcloud

Run the following command to list your triggers:

```bash
gcloud eventarc triggers list --location=-
```

This command lists your triggers in all locations, and includes details such
as names, types, destinations, and statuses.

## What's next

- [Learn more about Eventarc](https://docs.cloud.google.com/eventarc/standard/docs/overview.md.txt).
- [Learn how to manage triggers](https://docs.cloud.google.com/eventarc/docs/managing-triggers.md.txt).