> For the complete documentation index, see [llms.txt](https://developers.bims.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bims.xyz/sdk-de-bims/notificaciones-a-usuarios.md).

# Notificaciones a Usuarios

## Presentación

Las notificaciones se presentan como una Alerta de BIMS y también en la sección de notificaciones en el encabezado.

![](/files/-MWfKPEpWlKX6aK6clkv)

## Interfaces

Existen dos interfaces para postear notificaciones: una para su uso desde el front-end y otra para su uso desde el back-end.

### Front-End

Para enviar una notificación desde el front-end utilizá la función pushNotification(JSON options). Esta función registra la notificación en la tabla *notifications* a través de la API, y envía un push para que el Usuario recipiente actualice sus notificaciones.

Los argumentos de la función pushNotification(JSON options) son los siguientes.

| Argumento | Tipo de Dato | Descripción                                                                                                                                                         | Requerido | Default   |
| --------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | --------- |
| title     | String       | Título de la Notificación                                                                                                                                           | Optativo  |           |
| message   | String       | Cuerpo de la Notificación                                                                                                                                           | Requerido |           |
| recipient | String       | Id del Usuario Destinatario                                                                                                                                         | Requerido |           |
| email     | Boolean      | Si TRUE entonces la notificación se envía también via e-mail al destinatario                                                                                        | Optativo  | FALSE     |
| link      | String       | Enlace de la notificación. Ruta relativa al host de BIMS.                                                                                                           | Optativo  |           |
| type      | String       | Tipo / Origen de la notificación. Referencia usualmente al feature de BIMS desde donde se originó. Consultá la lista de opciones en la tabla *notification\_types*. | Optativo  | "mailing" |

#### Ejemplo de Uso

```
<script>

	pushNotification({
		title: 					'Ticket Asignado',
		message: 				'@victor te asignó un nuevo ticket en el Pipeline "Soporte Técnico"',
		recipient: 			12,
		link:						'issues/index/1/2124',
		email: 					false,
		type:						'pipelines'
	});
	
</script>
```

### Back-End

Para enviar una notificación desde el back-end invocá desde un controlador el método $this->pushNotification(ARRAY options). Esta función registra la notificación en la tabla *notifications*, y envía un push para que el Usuario recipiente actualice sus notificaciones desde el front-end.

Los argumentos de la función pushNotification(ARRAY options) son los siguientes.

| Argumento | Tipo de Dato | Descripción                                                                                                                                                         | Requerido | Default   |
| --------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | --------- |
| title     | String       | Título de la Notificación                                                                                                                                           | Optativo  |           |
| message   | String       | Cuerpo de la Notificación                                                                                                                                           | Requerido |           |
| recipient | String       | Id del Usuario Destinatario                                                                                                                                         | Requerido |           |
| email     | Boolean      | Si TRUE entonces la notificación se envía también via e-mail al destinatario                                                                                        | Optativo  | FALSE     |
| link      | String       | Enlace de la notificación. Ruta relativa al host de BIMS.                                                                                                           | Optativo  |           |
| type      | String       | Tipo / Origen de la notificación. Referencia usualmente al feature de BIMS desde donde se originó. Consultá la lista de opciones en la tabla *notification\_types*. | Optativo  | "mailing" |

#### Ejemplo de Uso

```
$this->pushNotification(array(
    "title"			    => 		'Ticket Asignado',
    "message"		    => 		'@victor te asignó un nuevo ticket en el Pipeline "Soporte Técnico"',
    "recipient"		  => 		12,
    "type"          =>    'pipelines'
));
```
