PubSub is our tool to let you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object.Then we send this event according the subscription you have created.

Pubsub has two methods: Create Subscription and Subscribe. To receive messages published to a topic, you must Subscribe to it using the subscritpionID. Only messages published to the topic after the subscription is created are available to subscriber applications.

Subscribe method is a gRPC stream, which means that you need to keep an open connection every time you want to receive messages.

NOTE: We will provide you the following information, so you can connect to our services: gRPC host , API URL

How does it works ?

We have two different implementations: Single tenant and multi tenant. In the single tenant the client subscribes to a topic only using the topicName. In the multi tenant, the client needs to create a subscription (using filters) and then use the subscriptionID to receive messages. The following diagram shows how they differ:

Single tenant:

Steps to receive events from one topic:

1. Authenticate using Auth endpoint. It will return a JWT token.

2. Subscribe to a topic using the following gRPC method:

  syntax = "proto3";

package pubsub_subscriber.v1;

message SubscribeRequest {
 string topic = 1;
 }

message SubscribeResponse {
 string id     = 1;
 string type   = 3; 
 string action = 5;
 uint32 timestamp = 7;
 string resource_url = 9;
 }

service SubscriberService {
 rpc Subscribe( SubscribeRequest) returns (stream SubscribeResponse){}
 }

Multi tenant:

Steps to receive events from one topic:

1. Authenticate using Auth endpoint. It will return a JWT token.

2. Create a subscription calling CreateNewSubscription. This needs to be done only once.

3. Subscribe calling Subscribe gRPC method. You must use the subscriptionID returned in step 2:

  syntax = "proto3";

package pubsub_subscriber.v1;

message SubscribeRequest {
 string subscription_id = 3;
 }

message SubscribeResponse {
 string id     = 1;
 string type   = 3; 
 string action = 5;
 uint32 timestamp = 7;
 string resource_url = 9;
 }

service SubscriberService {
 rpc Subscribe( SubscribeRequest) returns (stream SubscribeResponse){}
 }

200OK

400Bad Request

401Unauthorized