RHrhythms
notifications

Send a notification to a specific user

Changed on

Sends a notification to a specific user within the current tenant using internal authentication.

This endpoint is intended for backend-triggered notifications where the originating user JWT may no longer be valid by the time the notification is sent. Default notifications require recipient_user_uuid, title, and message. For a playbook_budget_exceeded notification, provide playbook_run_uuid; the recipient and content are derived from the run.

post/internal/notifications/send

Request

  • Base URL
    https://api.rhythms.ai
  • URL
    https://api.rhythms.ai/internal/notifications/send
  • Auth
    none required

Request body

notification_kindstring

Optional notification kind. For 'playbook_budget_exceeded', playbook_run_uuid is required and recipient, title, and message are derived from the run.

recipient_user_uuidstring

UUID of the user who should receive the notification. Required unless notification_kind is 'playbook_budget_exceeded'

thread_uuidstring

UUID of the conversation thread to deep link to

playbook_run_uuidstring

UUID of the playbook run. Required when notification_kind is 'playbook_budget_exceeded'

titlestring

Short title for the notification (2-3 words). Required unless notification_kind is 'playbook_budget_exceeded'

messagestring

Detailed message content. Required unless notification_kind is 'playbook_budget_exceeded'

channelstring

Notification channel: 'slack', 'email', or 'auto'

dedupe_keystring

Optional idempotency key to suppress duplicate notifications for the same recipient

Changes

  • 63a6f433ede5Revision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional