Ai knowledge and logicHelpers

add_conversation_event

Record an event in the conversation timeline.

add_conversation_event(context: dict, event: str) -> dict

Records a timestamped event in the conversation's timeline. Events appear in the conversation detail view in the dashboard, making them useful for auditing what happened during a conversation.


Parameters

NameTypeDescription
contextdictThe context object passed to your action
eventstrThe event text to record (max 1000 characters)

Returns

dict{"success": bool, "message": str, "eventId": str}

Behavior

  • Skipped in test/mock environments.

Examples

Log when a refund is processed

def execute_action(context):
    order_id = context["args"]["orderId"]
    amount = process_refund(order_id)

    add_conversation_event(context, f"Refund of ${amount} processed for order {order_id}")
    return {"success": True, "amount": amount}

Record a decision point

def execute_action(context):
    order = fetch_order(context["args"]["orderId"])

    if order["daysOld"] > 30:
        add_conversation_event(context, "Order outside 30-day return window — denied")
        return {"eligible": False, "reason": "Outside return window"}

    add_conversation_event(context, "Order eligible for return")
    return {"eligible": True}

On this page