Saltar al contenido principal

wiki-EVENTS-Communications-V1

Ver en Git

EVENTS Communications V1

COMMUNICATIONS.V1​

Este evento permite notificar a través del inbox a un usuario. El mensaje quedará en el inbox por una semana o durante el tiempo que se especifique. Además se puede evitar su borrado si es una comunicación de importancia.

Event Name:​

COMMUNICATIONS.V1

Creation Schema​

Para crearlo se envía:

  • user_ids: array de user ids,
  • expiration_date: string. formato: YYYY-MM-DDTHH:MM:SSZ Si no se incluye, dura 1 semana
  • dismissible: bool indica si el usuario lo puede eliminar del inbox,
  • message: objeto con locales. Es obligatorio enviar todos debido a que el front no tiene implementado un "locale default". Podría enviarse el mismo idioma en todos los locales. README.md celery-health.sh core docker docker-compose.yml docs features model.env requirements.dev.txt requirements.txt run_api.py run_celery.sh source test.html translations en_US: string, README.md celery-health.sh core docker docker-compose.yml docs features model.env requirements.dev.txt requirements.txt run_api.py run_celery.sh source test.html translations pt_BR: string, README.md celery-health.sh core docker docker-compose.yml docs features model.env requirements.dev.txt requirements.txt run_api.py run_celery.sh source test.html translations fr_FR: string, README.md celery-health.sh core docker docker-compose.yml docs features model.env requirements.dev.txt requirements.txt run_api.py run_celery.sh source test.html translations es_ES: string, README.md celery-health.sh core docker docker-compose.yml docs features model.env requirements.dev.txt requirements.txt run_api.py run_celery.sh source test.html translations es_AR: string },
  • external_link: string, con link que se abrirá en otra pestaña del navegador.
  • internal_link: string, con deep link. Sólo se incluye lo que va después del host.

Solo user_ids y message son obligatorios.

Ejemplo:

{
 "user_ids": [1,2,3],
 "expiration_date": "2024-09-09T00:00:00Z",
 "dismissible": true,
 "message": {
 "en_US": "",
 "pt_BR": "",
 "fr_FR": "",
 "es_ES": "",
 "es_AR": ""
 },
 "external_link": "",
 "internal_link": ""
}