Skip to content

Message

HTTP API schema

A message is an object that can be received and sent to endpoints.

Message fields

contextMessageContext

Message context including authorization and input plugin

correlationTokenstring

Token used for correlating related messages

headerMessageHeader

Message header with namespace, name, and version

targetMessageTarget

The target of the message

auth-tokenstring

Port OS bearer token available to plugins during dispatch when they need to call Port OS APIs.

secretsarray<Secret>

The secrets associated with the authorization link between the port OS principal and the plugin.

ItemSecret
ownerIdstring

The ID of the owner of the message

bodyobjectRequired

The message body, which can be any valid JSON object

View source specification ↗