AgentReplyPayloadDto

August 7, 2026 · View on GitHub

Fields

FieldTypeRequiredDescriptionExample
conversationIdString:heavy_check_mark:Conversation id to reply into. Obtained from the inbound agent event / bridge payload.64f5a1c2e8b7a3d9f0c1b2a3
integrationIdentifierString:heavy_check_mark:Channel integration identifier linked to the agent for this conversation (e.g. slack-support).slack-support
replyOptional<Reply>:heavy_minus_sign:Outbound message content. Exactly one of markdown, card, or toolApprovalCard. Optional files attach to the message. Cannot be combined with edit.
toolApprovalRequestOptional<ToolApprovalRequestPayloadDto>:heavy_minus_sign:Tool-lifecycle ledger row for a gated tool call. Pair with reply.toolApprovalCard (or another reply shape) to deliver the approval UI.
editOptional<EditPayloadDto>:heavy_minus_sign:In-place edit of a previously posted agent message. Cannot be combined with reply, resolve, signals, toolResults, toolApprovalRequest, addReactions, or deleteMessages.
resolveOptional<ResolveDto>:heavy_minus_sign:Mark the conversation resolved. May be combined with a final reply.
signalsList<Signal>:heavy_minus_sign:Side-effect signals executed during this turn: conversation metadata mutations or Novu workflow triggers.
toolResultsList<ToolResultDto>:heavy_minus_sign:Tool-call outcomes to persist in conversation history (typically before the assistant reply).
addReactionsList<AddReactionPayloadDto>:heavy_minus_sign:Emoji reactions to add to existing platform messages.
deleteMessagesList<DeleteMessagePayloadDto>:heavy_minus_sign:Delete previously posted platform messages. Removes the rendered message only — history is preserved.
typingOptional<Typing>:heavy_minus_sign:Per-turn typing/status control. Pass { status?: string } to set/update the status (omit status for "Thinking…"), or "stop" to clear it. Best-effort per platform.{
"status": "Looking up your order…"
}
errorOptional<Boolean>:heavy_minus_sign:Bridge reports that the customer runtime failed this turn. Cannot be combined with other actions. Novu delivers generic user-facing error copy.true