Actions5
- Message Actions
- Partner Actions
Message → Create
AI-generatedSummary
Create a new message with a specified type for a given receiver UUID, including an arbitrary JSON data payload.
Inputs
- Message Type (required) — The key that identifies the type of message. This should correspond to a message type known by the system (e.g., 'order_notification').
- Receiver ID (required) — The UUID of the message receiver. This value is validated at runtime to ensure it is a proper UUID.
- Data (JSON) (required) — A JSON object that contains the arbitrary payload data to be included in the message.
Output shape
a single JSON object containing the newly created message's ID
The output JSON includes at least the 'id' field, which is the unique identifier of the created message. If the API response does not include a valid ID, an error is thrown.
Examples
Example 1: Create a notification message
Set 'Message Type' to 'order_notification', provide a valid 'Receiver ID' UUID, and supply the JSON payload in 'Data (JSON)' that contains the details relevant to the notification.