vRealize Automation Event Broker Service API

Event Broker API Specification

What is the Event Broker REST API?

The event broker REST API provides features for managing subscriptions, event topics, events, and messages. The event broker includes the EventLog service, which provides a centralized location for events and a consistent way of recording events and querying for events in the vRA suite.

Typical Use Cases

The event broker service is used as follows:

  • Service providers register and manage event topics, event producers' ability to publish events, and event consumers' permissions to subscribe to events.

  • System administrators, or solution users register, update, or delete subscriptions to specified event topics.

  • Event consumers register to retrieve events that have given event topics.

Event producers publish events to the event broker service, and after receiving an event, the event broker service notifies event consumers that are subscribed to the event.

Key Concepts

Event Topic

Describes a set of events that have the same logical intent and the same structure. Every event is an instance of an event topic.

Event

Indicates a change in the state in the producer or any of the entities managed by it. The event is the entity that records information about the event occurrence.

Message

Transports information about the event between the various services and components. For example, from the producer to the event broker service, or from the event broker service to the subscribers.

Event Broker Service

The service that dispatches messages that are published by a producer to the subscribed consumers.

Payload

The event data.

Subscription

Indicates that a subscriber is interested in being notified about an event by subscribing to an event topic and defining the criteria that triggers the notification.

Subscriber

Consumes the events published to the event broker service based on the subscription definition. The subscriber might also be referred to as the consumer.

Provider

Registers event topics in the event broker service.

Producer

Publishes events to the event broker service.

How the Event Broker Service Works

The event broker workflow works as follows:

  1. Service providers register and manage event topic producers and consumers.

  2. Solution users and system administrators manage subscriptions to event types by registering, updating or deleting subscriptions.

  3. Event consumers register to retrieve event types.

  4. Event topic producers publish events to the event broker service.

  5. The event broker service notifies subscribed event consumers when events having an event type that they have subscribed to occur.

Additional Information

For more detailed information on using the event broker API, refer to:

  • The Workflow Subscriptions and Event Broker Terminology topic in the VMWare vRealize Automation Information Center documentation.

  • The vRA Programming Guide.

 

Related Documentation

Related Sample Code

  • vRealize Automation - Event Broker

    Contributor VMware

    vRealize Automation - Event Broker The event broker provides features for managing subscriptions, event topics, events, and messages. Available Use Case Get event topics Registers or updates an Even ...
    vRealize Automation api_vra_event_broker POSTMAN Collection
    Download

    0 Comments

    Updated 2 months ago