Ir al contenido

notification

El dominio notification tiene 6 acciones. En la superficie meta se alcanzan todas a través de arcane_notification; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

AcciónTítuloTipo
notification.dispatchDispatch notification from remote agent to managerescritura
notification.settings_deleteDelete notification settingsdestructiva
notification.settings_getGet notification settings by providerlectura
notification.settings_listGet all notification settingslectura
notification.settings_upsertCreate or update notification settingsescritura
notification.testTest notificationescritura

Dispatch notification from remote agent to manager

  • Tipo: escritura
  • Parámetros obligatorios: kind
  • Meta-herramienta: arcane_notification con "action": "dispatch"
  • Herramienta individual: arcane_notification_dispatch
  • Ruta de Arcane: POST /api/notifications/dispatch
  • ID de operación: dispatch-notification
  • Uso: Agent-to-manager route: apiKey is a remote environment’s access token (the apiKey returned by environment.create with useApiKey), not a user API key. A wrong or missing token fails with 401. kind is one of image_update, batch_image_update, container_update, batch_container_update, vulnerability_found, prune_report, auto_heal, and the matching payload object (imageUpdate, batchImageUpdate, containerUpdate, batchContainerUpdate, vulnerabilityFound, pruneReport, autoHeal) must be set (a missing payload fails with 400 naming it). Sends a real notification, attributed to that environment, through every enabled provider subscribed to the event (and queues mobile push when it is enabled), and returns 500 “dispatch failed” if any provider send fails even though others may have delivered. delivered (providers that succeeded plus a queued push) is only counted for image_update and batch_image_update and is always 0 for the other kinds. batchImageUpdate entries without hasUpdate true are dropped, so a batch with none sends nothing. Use notification.test to check one provider instead.
  • Acciones relacionadas: notification.test, notification.settings_list, environment.create

Delete notification settings

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: provider
  • Meta-herramienta: arcane_notification con "action": "settings_delete"
  • Herramienta individual: arcane_notification_settings_delete
  • Ruta de Arcane: DELETE /api/environments/{id}/notifications/settings/{provider}
  • ID de operación: delete-notification-settings
  • Uso: Removes one provider’s saved settings and credentials (instance-wide), so it stops sending. To pause it without losing the configuration, call notification.settings_upsert with enabled false instead. Reports success even when the provider was not configured.
  • Acciones relacionadas: notification.settings_list, notification.settings_upsert

Get notification settings by provider

  • Tipo: lectura
  • Parámetros obligatorios: provider
  • Meta-herramienta: arcane_notification con "action": "settings_get"
  • Herramienta individual: arcane_notification_settings_get
  • Ruta de Arcane: GET /api/environments/{id}/notifications/settings/{provider}
  • ID de operación: get-notification-settings
  • Uso: Reads one provider’s settings. provider is the name (discord, email, telegram, signal, slack, ntfy, pushover, gotify, matrix, googlechat, generic) as shown by notification.settings_list. Fails with 404 when that provider was never saved, and credential fields come back blanked.
  • Acciones relacionadas: notification.settings_list, notification.settings_upsert

Get all notification settings

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_notification con "action": "settings_list"
  • Herramienta individual: arcane_notification_settings_list
  • Ruta de Arcane: GET /api/environments/{id}/notifications/settings
  • ID de operación: get-all-notification-settings
  • Uso: Lists every configured provider with its id, enabled flag and config (including the events map). Settings are instance-wide, whatever environmentId is passed. Credential fields (tokens, passwords, the Google Chat webhookUrl) come back blanked. Requires the notifications:manage permission.
  • Acciones relacionadas: notification.settings_get, notification.settings_upsert, notification.test

Create or update notification settings

  • Tipo: escritura
  • Parámetros obligatorios: config, enabled, provider
  • Meta-herramienta: arcane_notification con "action": "settings_upsert"
  • Herramienta individual: arcane_notification_settings_upsert
  • Ruta de Arcane: POST /api/environments/{id}/notifications/settings
  • ID de operación: create-or-update-notification-settings
  • Uso: Creates or replaces one provider’s settings (instance-wide, whatever environmentId is passed): config replaces the stored config, except that blank credential fields, a blank host/smtpHost and an omitted events map keep their stored values, so read notification.settings_get first and send the full config. provider is discord, email, telegram, signal, slack, ntfy, pushover, gotify, matrix, googlechat or generic. For a plain webhook use generic with config.webhookUrl (plus method, contentType, titleKey, messageKey) and config.events, a map of image_update, container_update, vulnerability_found, prune_report, auto_heal to true/false (an absent event counts as enabled). Changing an email/signal/ntfy/gotify/matrix host requires resending its credentials.
  • Acciones relacionadas: notification.settings_get, notification.test, notification.settings_list, notification.settings_delete

Test notification

  • Tipo: escritura
  • Parámetros obligatorios: provider
  • Meta-herramienta: arcane_notification con "action": "test"
  • Herramienta individual: arcane_notification_test
  • Ruta de Arcane: POST /api/environments/{id}/notifications/test/{provider}
  • ID de operación: test-notification
  • Uso: Sends a sample notification through one saved provider (notification.settings_upsert first, else it fails with 400) and sends even when the provider is disabled or the event is unsubscribed, returning a warning that real notifications would not send. type picks the sample: simple (default), image-update, batch-image-update, vulnerability-found, prune-report, auto-heal. environmentId only sets the environment named in the message, and an unknown environmentId fails with 404. A delivery failure is returned as an error.
  • Acciones relacionadas: notification.settings_upsert, notification.settings_get, notification.dispatch