Events: handling and receiving events

Events: Handling and receiving events


Some interactions on VTEX IO can generate events and they can be used as triggers for actions, like the activity on this step. For now, we will use the events fired by the events-example app.

Events on VTEX IO

On VTEX IO apps, events can be fired and used to trigger actions. For example, an app that listens for order placements and triggers a confirmation e-mail. It is important to highlight that events are workspace and account bound, which means that events are only visible for the account and workspace where they were fired. Events fired on your personal workspace will only be listened to by apps linked on this same workspace.

Listening to events on the app

  1. First, we are starting the event firing on the events-example app. This app will fire an event every X seconds. After running vtex link on the events-example directory, click on the healthcheck route available and a "ok" message should appear on the browser:


    This healthcheck route access creates a cache context needed for the VTEX IO to fire events. Without it, the events-example app won't be able to fire the events our app is going to listen to.

  2. We need to add the event handler on the Service declaration to refer to what the app is supposed to do when listening to the event. To do so, on the /node/index.ts file, complement Service declaration:

    + const THREE_SECONDS_MS = 3 * 1000
    + const CONCURRENCY = 10
    export default new Service<Clients, State, ParamsContext>({
      clients: {
        implementation: Clients,
        options: {
          default: {
            retries: 2,
            timeout: 10000,
    +      events: {
    +        exponentialTimeoutCoefficient: 2,
    +        exponentialBackoffCoefficient: 2,
    +        initialBackoffDelay: 50,
    +        retries: 1,
    +        timeout: THREE_SECONDS_MS,
    +        concurrency: CONCURRENCY,
    +      },
    +    },
    +  },

    Going by each configuration, we have the following:

    exponentialTimeoutCoefficientsecondsthe exponential factor by which the timeout will increase in each retry
    exponentialBackoffCoefficientsecondsthe exponential factor by which the backoff delay will increase in each retry
    initialBackoffDelaysecondsthe time the app will wait until the next retry
    retries-the maximum times the app will retry
    timeoutsecondsthe timeout until consider a failure attempt
    concurrency-the amount of simultaneous processes the event is able to perform

    By adding this code to the Service, we are adding to the Client of this Service, the capability to handle events. At this point, we are not yet using the Client itself when handling the event.

  3. For now, we are only going to create a log when receiving an event. To create this event handler, in the /node/event directory, go to the liveUsersUpdate.ts file and do the following:

    export async function updateLiveUsers() {
      console.log('EVENT HANDLER: received event')
  4. Now, we need to declare in the Service the reference to this function. On the /node/index.ts file, add this code:

    + import { updateLiveUsers } from './events/liveUsersUpdate'
    export default new Service<Clients, State, ParamsContext>({
    +  events: {
    +    liveUsersUpdate: updateLiveUsers,
    +  },
  5. We also need to modify the service.json file. In order to listen to events sent, we need to declare this to give the app's service this capability. You may do so, by modifying service.json file:

      "memory": 128,
      "ttl": 10,
      "timeout": 10,
      "minReplicas": 2,
      "maxReplicas": 10,
      "workers": 4,
    +  "events": {
    +    "liveUsersUpdate": {
    +      "sender": "",
    +      "keys": ["send-event"]
    +    }

    Note that we declare this by using the events resolver and the reference of the app that fires the event (declared as sender) and the event reference key (declared as keys).

  6. At last, run vtex link and wait for the event to be fired by the events-example app. When listened, the log should appear on the console, like this:


Any questions?

See the answersheet for this step or join us on our office hours

Help us make this content better!

VTEX IO courses are open source. If you see something wrong, you can open a pull request!

Make a contribution

or open an issue