Webhooks

Información general

Gracias a los webhooks, las aplicaciones de integración personalizada pueden suscribirse a eventos en Workplace y recibir 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 todas las aplicaciones de integración personalizada suscritas al tema pertinente del webhook.

De esta forma, las aplicaciones son más eficientes, ya que saben exactamente el momento en el que se ha producido un cambio y no tienen que basarse en las solicitudes a la API Graph continuas o, incluso, periódicas para obtener el contenido más reciente.

El mismo marco que impulsa Webhooks para Facebook es el que proporciona la compatibilidad de los webhooks con Workplace.

Suscripción a temas de los webhooks

El cuadro de diálogo Editar integración personalizada proporciona pestañas para todos los temas de los webhooks disponibles para las aplicaciones en Workplace.

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

Para añadir una nueva suscripción a un webhook sobre un tema determinado, debes proporcionar una dirección URL de devolución de llamada y un identificador de verificación y, a continuación, seleccionar los campos de suscripción que necesitas para la funcionalidad que proporcionará la aplicación.

Solo puedes suscribir una URL por tema de webhook, pero puedes usar la misma URL para varios temas.

Gestión de las solicitudes de verificación

Cuando añadas una suscripción nueva o modifiques una existente, los servidores de Facebook realizarán una solicitud GET a tu URL de devolución de llamada para verificar la validez del servidor de devolución de llamada.

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

  • 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 al crear la suscripción

Cuando recibes una solicitud HTTP GET en la URL de devolución de llamada, puedes usar el parámetro verify_token para validar que la solicitud procede de un servidor de Facebook.

Seguridad de los webhooks

Todas las llamadas de los webhooks a direcciones URL de devolución de llamada definidas por el desarrollador se realizan mediante HTTPS, lo que garantiza la seguridad de las cargas útiles de los webhooks en el transporte.

Con el fin de proporcionar seguridad adicional, se incluye un encabezado X-Hub-Signature-256 en HTTP en cada carga útil de POST; deberías usarlo para verificar que la carga útil procede de un servidor de Facebook.

Para obtener información detallada de este comportamiento, consulta la documentación sobre el marco de los webhooks de Facebook.

Temas de webhooks

La actividad de Workplace está agrupada en temas. Cada tema tiene una serie de campos que se asignan a eventos de un tema determinado. Las aplicaciones pueden suscribirse a actualizaciones de webhooks de cada uno de los temas y campos específicos dentro de cada tema.

Actualmente, Workplace proporciona webhooks para los temas y grupos siguientes:

Página

Encontrarás más información en los documentos de referencia sobre los temas de página.

Campo de suscripciónComportamiento

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 un chat de Workplace.

message_deliveries

Se activa cuando se entrega un mensaje que ha enviado una página de integración personalizada (bot).

messaging_postbacks

Se activa cuando se pulsa un botón de postback en el chat de Workplace.

message_reads

Se activa cuando el destinatario lee un mensaje de una página de integración personalizada (bot).

Grupo

Encontrarás más información en los documentos de referencia sobre los temas de grupo.

Campo de suscripciónComportamiento

posts

Se activa cuando se añade, se actualiza o se elimina una publicación en un grupo.

comments

Se activa cada vez que se añade, se actualiza o se elimina un comentario nuevo en una publicación de un grupo.

membership

Se activa cuando cambia la pertenencia de un grupo.

Usuario

Encontrarás más información en los documentos de referencia sobre los temas de usuario.

Campo de suscripciónComportamiento

status

Se activa cuando un usuario publica o edita una actualización de estado en su perfil.

events

Se activa cada vez que un usuario crea, acepta o rechaza un evento.

message_sends

Se activa cada vez que un usuario envía un mensaje de chat de Workplace.

Enlace

Encontrarás más información en los documentos sobre las vistas previas autenticadas.

Campo de suscripciónComportamiento

preview

Se activa cuando Workplace necesita recuperar información sobre una URL.

collection

Solo es pertinente para las aplicaciones de la lista de autorizados que admiten la navegación jerárquica del editor de publicaciones.

Seguridad

Encontrarás más información en los documentos de referencia sobre los temas de seguridad.

sessions

Eventos que se activan cuando un usuario inicia o cierra sesión en Workplace.

EventoComportamiento

log_in

Un usuario ha iniciado sesión en Workplace con contraseña o inicio de sesión único mediante la web o la aplicación para móviles.

log_out

Un usuario ha cerrado sesión en Workplace con contraseña o inicio de sesión único mediante la web o la aplicación para móviles.

No incluye el cierre de sesión forzado iniciado por un administrador (consulta admin_force_log_out)

passwords

Eventos que se activan cuando un usuario cambia su contraseña o solicita un restablecimiento de contraseña.

EventoComportamiento

password_change

Se ha cambiado la contraseña de un usuario después de completar el proceso de recuperación de la contraseña o bien mediante la configuración de la cuenta.

password_reset_request

Se ha iniciado un flujo de recuperación de la contraseña de un usuario y se ha enviado un código a la dirección de correo electrónico del usuario.

password_reset_wrong_code

Un usuario ha introducido un código de recuperación incorrecto para restablecer la contraseña.

password_reset_success

Se ha completado correctamente el flujo de recuperación de la contraseña de un usuario.

admin_activity

Eventos que se activan cuando se añade o elimina un administrador de una comunidad de Workplace.

EventoComportamiento

admin_set_to_unclaimed

Un administrador ha definido el estado de la cuenta de un usuario en No reclamada desde el panel para administradores o mediante la API de administración de cuentas.

admin_force_log_out

Un administrador ha forzado el cierre de sesión de un usuario en todos los dispositivos desde el panel para administradores.

admin_deactivate

Un administrador ha desactivado una cuenta desde el panel para administradores o mediante la API de administración de cuentas.

admin_activate_account

Un administrador ha activado una cuenta desde el panel para administradores o mediante la API de administración de cuentas.

force_password_reset

Un administrador ha forzado el restablecimiento de la contraseña de un usuario desde el panel para administradores.

admin_create_account

Un administrador ha creado una cuenta desde el panel para administradores.

two_factor

Eventos que se activan cuando una persona activa o desactiva la autenticación en dos pasos.

EventoComportamiento

two_factor_enable

Un usuario ha activado la autenticación en dos pasos en la pestaña Configuración. Esto no incluye los casos en los que un usuario confirma un teléfono particular, pero indica que se ha activado la función.

two_factor_disable

Un usuario ha desactivado la autenticación en dos pasos en la pestaña Configuración. Esto no incluye los casos en los que un usuario desactiva los dos pasos para un teléfono particular, pero indica que se ha desactivado la función.