Workato Messages API
Endpoints for publishing messages to event topics and consuming messages from event topics.
Workato Messages API is one of 11 APIs that Workato publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, rate-limit docs, an AsyncAPI specification, and 2 JSON Schemas.
This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against 5 base URLs: https://www.workato.com, https://app.eu.workato.com, https://app.jp.workato.com, https://app.sg.workato.com, https://app.au.workato.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Workato Messages API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— API client token obtained from the Workato platform. Include as Authorization: Bearer {token}.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.
Endpoints for publishing messages to event topics and consuming messages from event topics.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ConsumeRequest (4 properties), Message (3 properties), BatchPublishResponse (2 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Workato 10
Other APIs Workato publishes across the network.