Webhooks - Documentación - Meta for Developers

Información general

Webhooks permite que las apps de integración personalizada se suscriban a eventos en Workplace y reciban actualizaciones en tiempo real. Cuando se produce un cambio en Workplace, se envía una solicitud HTTPS POST a una URL de devolución de llamada para cada una de las apps de integración personalizada que están suscritas al tema del webhook pertinente.

De esta manera, las apps resultan más eficientes, porque identifican cuando se produce un cambio, y, entonces, deja de ser necesario que usen solicitudes de la API Graph continuas o, incluso, periódicas para obtener el último contenido.

El marco que utiliza Webhooks de Facebook es el mismo que permite que el webhook sea compatible para Workplace.

Suscripción a los temas del webhook

El cuadro de diálogo Editar integración personalizada proporciona pestañas a los temas del webhook que están disponibles para las apps en Workplace.

La pestaña "Webhooks" en el cuadro de diálogo "Editar integración personalizada"

Para agregar una nueva suscripción al webhook en relación con un tema específico, proporciona una URL de devolución de llamada y un token de verificación. Luego, selecciona los campos de suscripción que sean necesarios para la funcionalidad que ofrecerá tu app.

Solo puedes suscribir una URL por tema del webhook, pero sí puedes utilizar la misma URL para varios temas.

Manejo de solicitudes de verificación

Cuando agregas una nueva suscripción o modificas una que ya existe, los servidores de Facebook realizarán una solicitud GET a tu URL de devolución de llamada para verificar que el servidor de devolución de llamada sea válido.

Se agregará una cadena de consulta a esta URL con los siguientes parámetros:

hub.mode: la cadena "subscribe" se pasa en este parámetro.
hub.challenge: una cadena aleatoria.
hub.verify_token: el valor verify_token que especificaste cuando creaste la suscripción.

Al recibir una solicitud HTTP GET en tu URL de devolución de llamada, puedes usar el parámetro verify_token para validar que provenga de un servidor de Facebook.

Seguridad del webhook

Todas las llamadas de webhook a las URL de devolución de llamada que definió el desarrollador se realizan a través de HTTPS, lo que asegura la seguridad a nivel de transporte de las cargas del webhook.

Con el fin de proporcionar seguridad adicional, se incluye una X-Hub-Signature-256 de encabezado HTTP en cada carga "POST", que se recomienda que utilices para verificar que la carga provino de un servidor de Facebook.

Consulta la documentación sobre el Marco de webhook de Facebook para obtener información detallada de este comportamiento.

Temas de webhook

La actividad de Workplace se agrupa en temas. Cada uno de estos temas contiene un número de campos, que se asignan a eventos sobre un determinado tema. Las apps pueden suscribir actualizaciones de webhooks de cada uno de los temas y campos específicos dentro de los temas.

Workplace ofrece en estos momentos webhooks para los siguientes temas y grupos:

Página

Hay más información disponible en la documentación de referencia sobre Tema de la página.

Campo de suscripción	Comportamiento
`mention`	Se activa cuando se menciona una página de integración personalizada (bot) en un grupo.
`messages`	Se activa cuando se envía un mensaje a una página de integración personalizada (bot) en Work Chat.
`message_deliveries`	Se activa cuando se entrega un mensaje que envió una página de integración personalizada (bot).
`messaging_postbacks`	Se activa cuando se presiona un botón de postback en Work Chat.
`message_reads`	Se activa cuando el destinatario lee un mensaje que se envió desde una página de integración personalizada (bot).

Grupo

Hay más información disponible en la documentación de referencia sobre Tema de grupo.

Campo de suscripción	Comportamiento
`posts`	Se activa cuando se agrega, actualiza o elimina una publicación en un grupo.
`comments`	Se activa cuando se agrega, actualiza o elimina un nuevo comentario en una publicación de un grupo.
`membership`	Se activa cuando cambian los miembros de un grupo.

Usuario

Hay más información disponible en la documentación de referencia sobre Tema de usuario.

Campo de suscripción	Comportamiento
`status`	Se activa cuando un usuario hace una publicación o edita la actualización de estado de un nuevo perfil.
`events`	Se activa cuando un usuario crea, acepta o rechaza un evento.
`message_sends`	Se activa cuando un usuario envía un mensaje de Workplace Chat.

Enlace

Encontrarás más información en los documentos Vistas previas autenticadas.

Campo de suscripción	Comportamiento
`preview`	Se activa cuando Workplace necesita recuperar información sobre una URL.
`collection`	Solo relevante para las apps en la lista de autorizados que admiten la navegación jerárquica del editor de publicaciones.

Seguridad

Hay más información disponible en la documentación de referencia sobre Tema de seguridad.

`sessions`

Los eventos que se activan cuando una persona inicia o cierra sesión en Workplace.

Evento Comportamiento

Evento	Comportamiento
`log_in`	El usuario inició sesión en Workplace con contraseña o inicio de sesión único (SSO) en internet o en apps para celulares.
`log_out`	El usuario cerró la sesión en Workplace con contraseña o inicio de sesión único (SSO) en internet o en apps para celulares. No incluye el cierre de sesión forzoso impuesto por el administrador (ver `admin_force_log_out`).

log_in

El usuario inició sesión en Workplace con contraseña o inicio de sesión único (SSO) en internet o en apps para celulares.

log_out

El usuario cerró la sesión en Workplace con contraseña o inicio de sesión único (SSO) en internet o en apps para celulares.

No incluye el cierre de sesión forzoso impuesto por el administrador (ver admin_force_log_out).

`passwords`

Los eventos que se activan cuando una persona cambia su contraseña o solicita un restablecimiento de la contraseña.

Evento	Comportamiento
`password_change`	Se cambió la contraseña de un usuario después de finalizar el proceso de recuperación de la contraseña o a través de la configuración de la cuenta.
`password_reset_request`	Se inició el proceso de recuperación de la contraseña de un usuario, y se envió un código a la dirección de correo electrónico de dicho usuario.
`password_reset_wrong_code`	Un usuario ingresó un código de recuperación de la contraseña incorrecto.
`password_reset_success`	Finalizó correctamente el proceso de recuperación de la contraseña de un usuario.

`admin_activity`

Los eventos que se activan cuando se agrega un administrador a una comunidad de Workplace o se lo elimina de dicha comunidad.

Evento	Comportamiento
`admin_set_to_unclaimed`	Un administrador configuró el estado de la cuenta de un usuario en No reclamada desde el panel para administradores o a través de la API de administración de cuentas.
`admin_force_log_out`	Un administrador obligó desde el panel para administradores a un usuario a cerrar sesión en todos los dispositivos.
`admin_deactivate`	Un administrador desactivó una cuenta desde el panel para administradores o a través de la API de administración de cuentas.
`admin_activate_account`	Un administrador activó una cuenta desde el panel para administradores o a través de la API de administración de cuentas.
`force_password_reset`	Un administrador obligó desde el panel para administradores a un usuario a restablecer su contraseña.
`admin_create_account`	Un administrador creó una cuenta desde el panel para administradores.

`two_factor`

Los eventos que se activan cuando una persona habilita o deshabilita la autenticación en dos pasos.

Evento	Comportamiento
`two_factor_enable`	Un usuario activó la autenticación en dos pasos en la pestaña Configuración. Esto no captura cuando una persona confirma un teléfono determinado, pero indica que la función estaba activada.
`two_factor_disable`	Un usuario desactivó la autenticación en dos pasos en la pestaña Configuración. Esto no captura cuando una persona desactiva los dos pasos de un teléfono determinado, pero indica que la función estaba desactivada.