ConsumeRequest is a JSON Structure definition published by Workato, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/workato/refs/heads/main/json-structure/workato-event-streams-consume-request-structure.json",
"name": "ConsumeRequest",
"description": "Options for consuming messages from a topic.",
"type": "object",
"properties": {
"after_message_id": {
"type": "string",
"description": "Retrieve messages published after this message ID. Cannot be used together with since_time."
},
"since_time": {
"type": "datetime",
"description": "Retrieve messages published after this RFC 3339 timestamp. Cannot be used together with after_message_id."
},
"batch_size": {
"type": "int32",
"description": "Maximum number of messages to return. Must be between 1 and 50.",
"minimum": 1,
"maximum": 50
},
"timeout_secs": {
"type": "int32",
"description": "Long-polling timeout in seconds. If no messages are available, the server waits up to this many seconds before returning an empty response. Maximum is 60 seconds. Default is 0 (no long polling).",
"minimum": 0,
"maximum": 60,
"default": 0
}
}
}
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.