Workato · Schema

BatchPublishResponse

Results of a batch publish operation.

AgenticAPI ManagementAutomationB2BEmbedded iPaaSEnterpriseIntegrationiPaaSOrchestrationWorkflow

Properties

Name Type Description
is_partial_error boolean Whether some messages in the batch failed to publish. If true, check individual message results for failures.
message_ids object Map of array index (as string) to individual publish result. Keys correspond to positions in the submitted payloads array.
View JSON Schema on GitHub

JSON Schema

workato-event-streams-batch-publish-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workato/refs/heads/main/json-schema/workato-event-streams-batch-publish-response-schema.json",
  "title": "BatchPublishResponse",
  "description": "Results of a batch publish operation.",
  "type": "object",
  "properties": {
    "is_partial_error": {
      "type": "boolean",
      "description": "Whether some messages in the batch failed to publish. If true, check individual message results for failures."
    },
    "message_ids": {
      "type": "object",
      "description": "Map of array index (as string) to individual publish result. Keys correspond to positions in the submitted payloads array.",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "message_id": {
            "type": "string",
            "description": "Unique identifier assigned to the published message."
          },
          "result": {
            "type": "string",
            "description": "Result status for this individual message."
          }
        }
      }
    }
  }
}