Algebraix logo
Powered by Redocly

Usuarios

UsuariosWebhook

Este webhook se utiliza para notificar eventos relacionados con los usuarios registrados en Algebraix.
Los eventos incluyen:

  • Usuarios nuevos: Cuando se registra un nuevo usuario.
  • Usuarios actualizados: Cuando la información de un usuario existente es modificada.
  • Usuarios eliminados: Cuando un usuario es eliminado.

El payload enviado en cada evento incluye información detallada del usuario (Profesores, Padres de familia, Estudiantes, Solicitantes).

Este webhook es ideal para mantener sincronizados los datos de usuarios en sistemas externos, proporcionando actualizaciones en tiempo real.

Request
header Parameters
Content-Type
required
string

Tipo de contenido

Example: application/json
Content-Length
required
string

indica el tamaño del cuerpo de la solicitud HTTP

Example: 655
x-algebraix-operation
required
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Example: INSERT
x-algebraix-user_auth
required
string

Identificador único del estudiante

Enum: "Profesor" "Padre de familia" "Estudiante" "Solicitante"
Example: PARENT
authorization
string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0
ADDITIONAL-PROPERTIES
string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value
Request Body schema: application/json
Any of:
id
string

Identificador único

is_active
boolean

Indica si se encuentra activo

is_tutor
boolean

Muestra si es tutor

username
string

Nombre de usuario

title
string

Título del profesor

name
string

Nombre del profesor

lastname
string

Apellido completo del profesor

lastname1
string

Primer apellido

lastname2
string

Segundo apellido

has_picture
boolean

Indica si tiene foto

has_profile_picture
boolean

Indica si tiene foto de perfil

email
string

Correo electrónico

object

Propiedades de la cuenta de google: $username@$domain

use_authenticator
boolean

Indica si tiene habilitada la autenticación de doble factor

birthday
string

Fecha de cumpleaños del profesor

sex
string

Sexo del profesor

Enum: "MALE" "FEMALE"
address_line_1
string

Primera parte de la dirección

address_line_2
string

Segunda parte de la dirección

city
string

Ciudad

state
string

Estado

zipcode
string

Código Postal

telephone
string

Número de teléfono

mobile_telephone
string

Número de celular

emergency_telephone
string

Número de teléfono en caso de emergencia

blood_type
string

Tipo de sangre del profesor

Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"
allergies
string

Alergias del profesor

language_preference
string

Idioma preferido

Enum: "ES" "EN"
object

Si se habilitó la copia automática de mensajes, obtendrá copia del mensaje que el usuario envíe

can_add_reports
boolean

Permiso para crear reportes

can_add_annotations
boolean

Permiso para crear anotaciones

can_view_annotations
boolean

Permiso para ver anotaciones

has_syt_exit_permission
boolean

Permiso para entrega de estudiantes (salidas y transportes)

can_block_shadow
boolean

Indica si está activo "Bloquear ver sesión del usuario"

object

Usa checador

create_date_time
string

Fecha de creación del profesor

last_modification_time
string

Última fecha de modificación del profesor

Responses
200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples
application/json
{
  • "id": "WADFERF3",
  • "is_active": true,
  • "is_tutor": false,
  • "username": "PROFESOR01",
  • "title": "ING. SISTEMAS",
  • "name": "JOSE LUIS",
  • "lastname": "RUIZ SOTO",
  • "lastname1": "RUIZ",
  • "lastname2": "SOTO",
  • "has_picture": false,
  • "has_profile_picture": false,
  • "email": "profesor01@gmail.com",
  • "google_account": {
    },
  • "use_authenticator": false,
  • "birthday": "10/07/1990",
  • "sex": "MALE",
  • "address_line_1": "camino a san pablo 34",
  • "address_line_2": "",
  • "city": "xochimilco",
  • "state": "ciudad de mexico",
  • "zipcode": "16200",
  • "telephone": "5565216431",
  • "mobile_telephone": "+52555525352",
  • "emergency_telephone": "5555233974",
  • "blood_type": "O+",
  • "allergies": "",
  • "language_preference": "EN",
  • "message_bcc_user": {
    },
  • "can_add_reports": false,
  • "can_add_annotations": false,
  • "can_view_annotations": false,
  • "has_syt_exit_permission": false,
  • "can_block_shadow": false,
  • "timeclock": {
    },
  • "create_date_time": "2023-12-12 14:43:51",
  • "last_modification_time": "2023-12-12 14:43:51"
}