Skip to main content
GET
/
api
/
agents
/
{agent_uid}
/
notifications
Get notification config
curl --request GET \
  --url https://api.example.com/api/agents/{agent_uid}/notifications
Returns the Slack notification configuration for an agent.

​
Path parameters

​
agent_uid
string
required
UUID of the agent.

​
Response

When notifications are configured: 
{
  "status": "success",
  "status_code": 200,
  "data": {
    "notification_config": {
      "slack_channel_id": "C0123456789",
      "events": {
        "action_taken": true,
        "approval_required": true,
        "outcome": true,
        "error": true,
        "digest": false
      }
    }
  }
}
When notifications are not configured: 
{
  "status": "success",
  "status_code": 200,
  "data": {
    "notification_config": null
  }
}

​
Event types

EventDescription
action_takenAgent completed a tool action (sent email, posted Slack message, etc.)
approval_requiredAgent created an HIL approval task and is waiting for a human decision
outcomeAgent run finished (completed or failed)
errorAgent run encountered an error
digestPeriodic summary of agent activity