Pub/Sub API has been the talk of the town for some and I got to play with it recently. There are some code example in the pub / sub API pilot documentation but that’s only available in Python. Being a Node.js enthusiast I wanted to establish the pub / sub api using node.js.
– jsforce -> To get the authentication details.
– avro-js -> Converting the binary response from subscribe call to json & vice-versa
– grpc -> Core GRPC library
– @grpc/proto-loader -> This library is used to load the proto file.
Authenticating & connecting to Salesforce
As of now pub/sub api do not provide any method / rpc for authenticating the user. You will have to perform the login call using jsforce library or directly via rest api to get the details. The details that are required are
The above details will be set as metadata headers and will be used to setup the initial connection with the grpc server.
Topic Info & Schema Info
Salesforce transmits the data in avro binary format. To read this format we would need the schema information to convert the binary to readable json format. The salesforce proto file provides 2 rpc for the same.
GetTopic -> Pass the topic name (Platform event or CDC name) to get the schemaId. This schemaId will be passed to the GetSchema rpc to get the actual schema.
GetSchema -> Pass the schema Id retrieved in the previous GetTopic call to get the schema which will be used for avro conversion.
Now that we all the prerequisites , let do the actual thing, subscribing to a platform event. One thing to note here is that both the input & output of the Subscribe rpc are streams (BiDirectional Stream).
Publishing an event
For publishing an event salesforce’s proto offers 2 rpc (bidirectional stream & unary). We will use the unary rpc to publish an event.
Hope it helps!
5 thoughts on “Connecting to Salesforce using Pub / Sub API (gRPC)”
Connecting to Salesforce using Pub / Sub API (gRPC) : Do you have any repo for pub/sub api ?
What should be sf.proto file look like ?
Here’s the proto file : https://github.com/developerforce/pub-sub-api-pilot/blob/main/pubsub_api.proto
Thanks Sameer, i was able to pass the error message for proto file. But i’m still getting “no such file roots.cer file” – Can you please post an example of roots.cer file. Thanks for helping community !!!
Are there instructions on how to run this application – will be a great help for sure.
What should roots.cer file look like ?