The client organisation's Azure Service Bus queue. A client may run more than one queue — queues can be set up per team or per group of teams. By default only RWActivity documents (and RWCustomActivity, where the user has activated it) are placed on the queue; RWComment documents can be added when the integration needs chat messages.
queueName — Queue name supplied by Whitespace Support alongside the key and connection string.
Operations
receive
receiveActivity
Poll or stream the queue for the oldest message, process it according to body.hardcodedActivity, then settle it so the queue deletes it. If the consumer crashes or times out the message is unlocked an
Messages
RWActivity
The activity document generated by a significant user action on the Whitespace Platform.
Content-Type: application/json
RWCustomActivity
Structurally the same as RWActivity, but generated by user-defined custom actions — for example triggering an integration-side consumer process to call a third-party rating service. Only present when
Content-Type: application/json
RWComment
A simple log of a text comment involving users associated with this queue. Only placed on the queue when the integration asks for comments to be included.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.