Contact UsGet started

Creating a trigger for budgets that sends messages to WebSocket connections

Written by
Updated at February 17, 2025

Create a trigger for budgets to send messages to WebSocket connections when threshold values are exceeded.

Getting started

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.

    Note

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

  • Service account with the api-gateway.websocketBroadcaster role. If you do not have a service account, create one.

  • A budget which, when exceeded, fires a trigger. If you do not have a budget, create one.

Creating a trigger

Note

The trigger is initiated within 5 minutes of being created.

  1. In the management console, select the folder where you want to create a trigger.

  2. Open API Gateway.

  3. In the left-hand panel, select Triggers.

  4. Click Create trigger.

  5. Under Basic settings:

    • Enter a name and description for the trigger.
    • In the Type field, select Budget.
    • In the Launched resource field, select API gateway.

  6. Under Budget settings, select your billing account and budget. You can select Any budget.

  7. 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 to send messages to WebSocket connections.

  8. Click Create trigger.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To create a trigger that sends messages to WebSocket connections, run this command:

yc serverless trigger create billing-budget \
  --name <trigger_name> \
  --billing-account-id <billing_account_ID> \
  --budget-id <budget_ID> \
  --gateway-id <API_gateway_ID> \
  --gateway-websocket-broadcast-path <path> \
  --gateway-websocket-broadcast-service-account-id <service_account_ID>

Where:

  • --name: Trigger name.
  • --billing-account-id: Billing account ID.
  • --budget-id: Budget ID.
  • --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:

id: a1sfe084v4h2********
folder_id: b1g88tflruh2********
created_at: "2019-12-04T08:45:31.131391Z"
name: budget-trigger
rule:
  billing-budget:
    billing-account-id: dn2char50jh2********
    budget-id: dn2jnshmdlh2********
    gateway_websocket_broadcast:
      gateway_id: d4eofc7n0mh2********
      path: /
      service_account_id: aje3932acdh2********
status: ACTIVE

To create a trigger for budgets, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.

Checking the result

Check that the trigger operates correctly. Do it by viewing the API gateway logs that present information about its incoming requests.

See also

Previous
Broker
Next
Creating a trigger for Data Streams