[Yandex Cloud documentation](../../../index.md) > [Yandex API Gateway](../../index.md) > [Step-by-step guides](../index.md) > Creating a trigger > Creating a trigger for Object Storage

# Creating a trigger for Object Storage that sends messages to WebSocket connections

Create a [trigger for Object Storage](../../concepts/trigger/os-trigger.md) to send messages to [WebSocket connections](../../concepts/extensions/websocket.md) when you create, move, or delete an [object](../../../storage/concepts/object.md) in a bucket.

## Getting started {#before-begin}

To create a trigger, you will need:

* API gateway. Messages will be sent to WebSocket connections accessing the API gateway at the path specified in the trigger settings. If you do not have an API gateway, [create one](../api-gw-create.md).

    {% note info %}

    The trigger does not call the API gateway when sending messages to WebSocket connections.

    {% endnote %}

* [Service account](../../../iam/concepts/users/service-accounts.md) with the `api-gateway.websocketBroadcaster` role. If you do not have a service account, [create one](../../../iam/operations/sa/create.md).

* [Bucket](../../../storage/concepts/bucket.md) whose object events will set off the trigger. If you do not have a bucket, [create one](../../../storage/operations/buckets/create.md) with restricted access.

## Creating a trigger {#trigger-create}

{% note info %}

The trigger is initiated within five minutes after it is created.

{% endnote %}

{% list tabs group=instructions %}

- Management console {#console}

    1. In the [management console](https://console.yandex.cloud), select the folder where you want to create a trigger.

    1. Navigate to **API Gateway**.

    1. In the left-hand panel, select ![image](../../../_assets/console-icons/gear-play.svg) **Triggers**.

    1. Click **Create trigger**.

    1. Under **Basic settings**:

        * Enter a name and description for the trigger.
        * In the **Type** field, select `Object Storage`.
        * In the **Launched resource** field, select `API gateway`.

    1. Under **Object Storage settings**:

        * In the **Bucket** field, select the bucket for which you want to create an object event trigger.
        * In the **Event types** field, select events that will set off the trigger.
        * Optionally, in the **Object key prefix** field, enter a prefix for filtering.
        * Optionally, in the **Object key suffix** field, enter a suffix for filtering.

    1. Under **Batch message settings**, specify:

        * Batch size. The values may range from 1 to 1,000. The default value is 1.
        * Maximum wait time. The values may range from 1 to 60 seconds. The default value is 1 second.

       The trigger groups events within the specified wait time period and sends them to WebSocket connections. The number of events cannot exceed the specified batch size.

    1. Under **API gateway settings**:
       * In the **API gateway** field, select the API gateway.
       * In the **Path** field, specify the path in the OpenAPI specification. Messages will be sent through WebSocket connections established using this path.
       * In the **Service account** field, select the [service account](../../../iam/concepts/users/service-accounts.md) to send messages to WebSocket connections.

    1. Click **Create trigger**.

- CLI {#cli}

    If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../../cli/quickstart.md#install).

    The folder used by default is the one specified when [creating](../../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id <folder_ID>` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

    To create a trigger that sends messages to WebSocket connections, run this command:
    
  ```bash
    yc serverless trigger create object-storage \
      --name <trigger_name> \
      --bucket-id <bucket_ID> \
      --prefix '<object_key_prefix>' \
      --suffix '<object_key_suffix>' \
      --events 'create-object','delete-object','update-object' \
      --batch-size <batch_size> \
      --batch-cutoff <maximum_wait_time> \
      --gateway-id <API_gateway_ID> \
      --gateway-websocket-broadcast-path <path> \
      --gateway-websocket-broadcast-service-account-id <service_account_ID>
    ```

    Where:

    * `--name`: Trigger name.
    * `--bucket-id`: Bucket ID.
    * `--prefix`: Bucket object key [prefix](../../concepts/trigger/os-trigger.md#filter). This is an optional setting. It is used for filtering.
    * `--suffix`: Bucket object key [suffix](../../concepts/trigger/os-trigger.md#filter). This is an optional setting. It is used for filtering.
    * `--events`: [Events](../../concepts/trigger/os-trigger.md#event) that set off the trigger.

    * `--batch-size`: Event batch size. This is an optional parameter. The values may range from 1 to 1,000. The default value is 1.
    * `--batch-cutoff`: Maximum wait time. This is an optional parameter. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups events for a period not exceeding `batch-cutoff` and sends them to WebSocket connections. The number of events cannot exceed `batch-size`.

    * `--gateway-id`: API gateway ID.
    * `--gateway-websocket-broadcast-path`: Path in the OpenAPI specification. Messages will be sent through WebSocket connections established using this path.
    * `--gateway-websocket-broadcast-account-id`: Service account ID with permissions to send messages to WebSocket connections.

    Result:

    ```text
    id: a1s5msktijh2********
    folder_id: b1gmit33hgh2********
    created_at: "2023-08-24T15:19:15.353909857Z"
    name: os-trigger
    rule:
      object_storage:
        event_type:
        - OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT
        - OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT
        - OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT
        bucket_id: s3-for-trigger
        prefix: dev
        suffix: 12.jpg
        batch_settings:
          size: "3"
          cutoff: 20s
        gateway_websocket_broadcast:
          gateway_id: d4eofc7n0mh2********
          path: /
          service_account_id: aje3932acdh2********
    status: ACTIVE
    ```

- API {#api}

  To create a trigger for Object Storage, use the [create](../../triggers/api-ref/Trigger/create.md) REST API method for the [Trigger](../../triggers/api-ref/Trigger/index.md) resource or the [TriggerService/Create](../../triggers/api-ref/grpc/Trigger/create.md) gRPC API call.

{% endlist %}

## Checking the result {#check-result}

Check that the trigger operates correctly. Do it by viewing the [API gateway logs](../api-gw-logs.md) that present information about its incoming requests.

## See also {#see-also}

* [Trigger for Object Storage that invokes a Cloud Functions function](../../../functions/operations/trigger/os-trigger-create.md)
* [Trigger for Object Storage that invokes a Serverless Containers container](../../../serverless-containers/operations/os-trigger-create.md)