Client Setup

Any gRPC client can be used to test propeller (eg Postman). Propeller supports server reflection, making it easier to explore and interact with the service without importing .proto files manually. However, the api.proto file can also be imported into a client (like Postman) for additional reference or setup.

Channel request

Create a new gRPC request.

Set the following metadata headers:

• ClientHeader, as defined in propeller.toml config. Eg, x-user-id here.
• DeviceHeader, as defined in propeller.toml config. Eg, x-device-id here.
• Optionally, DeviceAttributeHeaders metadata headers can be set as defined in propeller.toml.

On Invoke, a connect_ack event would be received indicating successful connection with propeller backend.

SendEventToClientChannel request

Set the client_id to the value of ClientHeader metadata as also defined in the Channel request.

The event is received on the Channel.

Custom topic Subscription from the client

Clients can subscribe to custom topics (eg, test-topic here)

SendEventToTopic request

Events can be sent to custom topics from the backend.

The sent event is received on the channel.

---