Publish message

POST 
/messages/publication

Publishes a single message. Messages are published to specific partitions computed from their correlation keys. The endpoint does not wait for a correlation result. Use the message correlation endpoint for such use cases.

Request

application/json

Body

required

name stringrequired

The name of the message.

correlationKey stringrequired

The correlation key of the message.

timeToLive int64

Timespan (in ms) to buffer the message on the broker.

messageId stringnullable

The unique ID of the message. Only useful to ensure only one message with the given ID will ever be published (during its lifetime).

variables objectnullable

The message variables as JSON document.

property name* anynullable

Additional properties allowed.

tenantId stringnullable

The tenant of the message sender.

Responses

200

The message was published.

application/json

Schema

Schema

tenantId string

The tenant ID of the message.

messageKey string

The key of the message

Example (from schema)

{
  "messageKey": "string",
  "tenantId": "string"
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

tenantId string

The tenant ID of the message.

messageKey int64

The key of the message

Example (from schema)

{
  "messageKey": 0,
  "tenantId": "string"
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

tenantId string

The tenant ID of the message.

messageKey string

The key of the message

Example (from schema)

{
  "messageKey": "string",
  "tenantId": "string"
}

400

The provided data is not valid.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...