Integración de EDD con Slack

Este documento cubre la configuración de la integración de Slack de Easy Digital Downloads.

Creación de Webhooks

Una vez que la extensión esté instalada y activada, puede navegar a Descargas > Ajustes > Extensiones > Slack y primero deberá crear un Webhook entrante para su equipo de Slack.

Esto permite que EDD Slack envíe notificaciones en su nombre, lo que significa que solo puede enviar notificaciones a los mismos canales a los que usted tiene acceso. Si tiene acceso a un canal privado, puede enviar notificaciones a ese canal privado, pero no puede enviar notificaciones a canales privados a los que no tiene acceso.

Al crear una integración de Webhook entrante, Slack le preguntará a qué canal desea publicar. Piense en esto como un "Canal predeterminado". Para cada notificación que cree en la extensión, puede designar diferentes canales si es necesario.

Una vez que haya generado un Webhook entrante, introdúzcalo en el campo "URL de Webhook predeterminada" y haga clic en "Guardar cambios". ¡Ahora puede proceder a Crear notificaciones!

Creación de Notificaciones

¡Ahora que tiene una URL de Webhook predeterminada configurada, es hora de configurar algunas notificaciones!

EDD Slack le permite configurar un número ilimitado de notificaciones para enviarlas a cualquier canal especificado en su equipo de Slack. Simplemente navegue a la página de configuración de la extensión y haga clic en "Añadir notificación de Slack" para mostrar el formulario de configuración. Estas configuraciones se pueden editar más adelante en cualquier momento.

Aquí hay una descripción de lo que hace cada campo:

• Identificador de esta notificación: Este campo es simplemente una etiqueta para usted y le ayuda a determinar qué notificación guardada hace qué. Puede introducir lo que desee aquí. Si no se introduce nada, se establecerá como "Nueva notificación de Slack" por defecto.
• Desencadenante de Slack: Define el desencadenante que resulta en que esta notificación envíe un mensaje a Slack. Puede ser una acción dentro de Easy Digital Downloads o una extensión compatible de Easy Digital Downloads. Según la elección del desencadenante, se añadirán campos adicionales al formulario y estarán disponibles diferentes reemplazos de texto para los campos Pre-texto del mensaje, Título del mensaje y Mensaje, de modo que se pueda pasar información pertinente sobre la notificación a Slack.
• Pre-texto del mensaje: Texto opcional que se muestra encima del Título del mensaje.
• Título del mensaje: Esto le permite controlar el Título del mensaje. Si no se introduce nada, se establecerá como el Identificador de la notificación anterior por defecto.
• Mensaje: Este es un campo opcional donde puede introducir texto más descriptivo dentro de la notificación, debajo del Pre-texto y el Título.
• URL de Webhook de Slack: Permite usar una URL de Webhook alternativa en casos especiales. Esto se puede usar en un evento en el que una Notificación deba enviarse a un Equipo diferente al que se define para el Webhook Predeterminado.
• Canal de Slack: Esto te permite anular el Canal de Slack del Webhook para esta Notificación en particular. Si deseas enviar notificaciones a un Usuario de Slack específico en tu Equipo, usa la sintaxis @nombredeusuario. Déjalo en blanco para el Canal Predeterminado definido por el Webhook. ¡Recuerda que este Canal debe ser uno al que el creador de la URL del Webhook tenga acceso!
• Color: Los mensajes enviados a Slack tendrán este color en una barra antes del mensaje.
• Nombre de usuario: Define el nombre del Usuario desde el cual aparecerá el mensaje. El Usuario no necesita existir en Slack y esto se puede establecer como desees. Por defecto, será el nombre de tu sitio de WordPress.
• Emoji o URL de imagen: Si la imagen o el emoji predeterminados utilizados para las notificaciones no son de tu estilo, este campo permitirá especificar gráficos personalizados. También puedes establecer cualquier Emoji de Slack Personalizado que desees para este campo.
• También aparecerán campos adicionales dependiendo del disparador de Slack seleccionado. Estos te permiten especificar para qué Descargas debe enviar una Notificación un Disparador, por ejemplo.

Cuando se elige un Disparador de Slack, se agregan Campos y etiquetas de Reemplazo de Texto adicionales al Formulario. Por ejemplo, esto es lo que verás al elegir el Disparador "Compra Completada":

Las etiquetas de Reemplazo de Texto permiten agregar información sobre el Disparador al contenido de la Notificación. De esta manera, puedes ver el contenido de un carrito para una Compra, el Total y otra información basada en el Disparador elegido.

Una vez que el Formulario se haya completado a tu gusto, haz clic en el botón "Guardar Notificación de Slack" en la parte inferior del formulario. Esto cerrará el Formulario y te llevará de vuelta a la pantalla anterior y mostrará la Notificación en verde para indicar que se ha Guardado. La Marca de Verificación verde mostrará que la Notificación está Activa. ¡Felicidades, has configurado tu primera Notificación de Slack!

Si en lugar de una Marca de Verificación verde, ves una "X" roja, la notificación está Inactiva. Esto puede suceder por una o más de las siguientes razones:

1. No se estableció una URL de Webhook como Predeterminada o no se proporcionó de otra manera como parte del Formulario.
2. El formulario se cerró sin Guardar.
3. Una Notificación guardada previamente estaba utilizando un Disparador que ya no está disponible. Esto puede suceder cuando se deshabilita un plugin que se integra con EDD Slack.

Configuración de una aplicación de Slack

Estos pasos son opcionales, pero desbloquean funcionalidad adicional dentro de EDD Slack. Si sigues estos pasos, podrás realizar acciones en tu sitio directamente desde una Notificación de Slack haciendo clic en un Botón dentro de una notificación de Slack, así como devolver datos de tu sitio usando Comandos Slash.

Nota: Para continuar, ¡tu sitio debe tener SSL habilitado!

Si tu sitio tiene SSL habilitado, verás opciones adicionales debajo de las Notificaciones de Slack creadas:

En la parte superior de esta sección, se mostrará una lista de los Desencadenadores disponibles que admiten Botones Interactivos. Si no se muestra ninguno, ¡aún puedes beneficiarte de configurar esto para usar Comandos de Barra!

Esta funcionalidad se basa en vincular una Aplicación de Slack a tu sitio web. Sigue el enlace para crear tu propia Aplicación de Slack haciendo clic en el botón “Crear Nueva Aplicación” para empezar.

Vinculación Inicial de la Aplicación de Slack:

El campo Nombre de la Aplicación puede ser lo que quieras. Se utiliza dentro de los Comandos de Barra como el “Nombre de Usuario” cuando te devuelve datos. El campo Espacio de Trabajo debe ser el Equipo al que deseas vincular tu tienda EDD. Haz clic en “Crear Aplicación” para continuar.

La siguiente pantalla te mostrará tu ID de Cliente, Secreto de Cliente y Token de Verificación para la Aplicación de Slack en la sección Credenciales de la Aplicación, más abajo en la página. Ingresa estos datos en la Configuración de Slack de EDD (Descargas > Ajustes > Extensiones > Slack) y haz clic en “Guardar Cambios” en la parte inferior de la pantalla.

Antes de poder hacer clic en el botón “Vincular Aplicación de Slack” que aparece, deberás definir una URL de Redirección para la Aplicación de Slack. De vuelta en la configuración de la Aplicación de Slack que creaste:

1. Haz clic en “OAuth & Permisos” a la izquierda de la pantalla.
2. Haz clic en “Añadir Nueva URL de Redirección”
3. Introduce https://tudominio.com/wp-admin/edit.php?post_type=download&page=edd-settings&tab=extensions&section=edd-slack-settings donde tudominio.com es el Dominio de tu sitio y haz clic en “Añadir” en el lado derecho del campo.
4. Haz clic en “Guardar URLs” en la parte inferior.

Ahora puedes volver a la página de Configuración de Slack de EDD y hacer clic en el botón “Vincular Aplicación de Slack”. Esto abrirá una nueva ventana donde iniciarás sesión en tu Equipo que se estableció previamente para Autorizar la Aplicación de Slack en tu sitio. De manera similar a las URLs de Webhook anteriores, esto significará que estará restringido a los mismos Canales a los que tiene acceso el Usuario de Slack que vinculó la Aplicación de Slack al sitio dentro del Equipo elegido.

Una vez Autorizada, la ventana emergente se cerrará sola y la Página de Configuración de Slack de EDD se actualizará, presentándote un mensaje de “Aplicación de Slack Vinculada Exitosamente”.

Ahora que este paso se ha completado, se han abierto Puntos Finales de API en tu sitio. Estos se utilizan tanto para Notificaciones Interactivas como para Comandos de Barra.

Los siguientes pasos son configurar tus Notificaciones Interactivas seguidas de tus Comandos de Barra.

Notificaciones interactivas

Para configurar Notificaciones Interactivas para EDD Slack, vuelve a la Configuración de tu Aplicación de Slack y haz clic en “Interactividad y Atajos” en el lado izquierdo de la pantalla.

Haz clic en el interruptor Desactivado en la esquina superior derecha para habilitarlos e introduce https://tudominio.com/wp-json/edd-slack/v1/slack-app/interactive-message/submit en el campo URL de la solicitud, donde tudominio.com es el dominio de tu sitio. Una vez que hayas terminado, haz clic en "Guardar cambios".

Comandos de barra diagonal

Los comandos de barra diagonal actúan como atajos para acciones específicas en Slack que puedes usar para interactuar con tu tienda EDD.

Para configurar los comandos de barra diagonal, dentro de la configuración de tu aplicación de Slack, haz clic en "Comandos de barra diagonal" y luego en "Crear nuevo comando". Esto abrirá una ventana donde se introducirán la configuración del comando de barra diagonal. 

EDD Slack utiliza un único comando de barra diagonal y lo dirige a diferentes funciones según un parámetro pasado. Aquí tienes un ejemplo de un comando /edd:

• Comando: /edd Recomendamos configurar el "Comando" en /edd, pero si decidieras nombrarlo /miTienda o cualquier otra cosa, también funcionará.
• URL de la solicitud: https://tudominio.com/wp-json/edd-slack/v1/slack-app/slash-command/submit donde tudominio.com es el nombre de dominio de tu sitio web.
• Descripción corta: Obtener información de EDD
• Sugerencia de uso: Ejecuta "/edd ayuda" para obtener sugerencias de uso
• Omitir canales/usuarios: Esto se puede dejar sin marcar en la mayoría de los casos. Habilitar esto modificará los parámetros enviados con un comando por un usuario. Más detalles aquí

Puedes probar los comandos de barra diagonal introduciendo /edd ayuda en cualquier canal al que tengas acceso. Se utilizarán Notificaciones Interactivas en lugar de Notificaciones normales cuando sea aplicable.

La extensión presenta varios comandos útiles que se pueden ejecutar dentro de Slack para recuperar datos o crear algo nuevo dentro de tu sitio de WordPress sin tener que iniciar sesión en tu sitio en absoluto.

Slack ya incluye muchos comandos de barra diagonal útiles que pueden ser de gran ayuda, como el comando /recordar. EDD Slack introduce algunos comandos nuevos que se aplican específicamente a los usuarios de Easy Digital Downloads.

La forma más fácil de ver todos los comandos de barra diagonal disponibles incluidos en EDD Slack es introducir /edd ayuda en Slack. Esto se puede hacer en cualquier lugar y los resultados solo serán visibles para ti. Se verán así:

*/edd sales*
Description: Show an Earnings Report for the Selected Time Period
Example: `/edd sales this_month`
Option(s): `today`, `yesterday`, `this_week`, `last_week`, `this_month`, `last_month`, `this_quarter`, `last_quarter`, `this_year`, `last_year`
Default: `this_month`

*/edd version*
Description: Outputs the current version of Easy Digital Downloads.
Example: `/edd version`

*/edd discount*
Description: Outputs information about a Discount Code. This can also be used to create new Discount Codes.
Examples:
    `/edd discount DISCOUNTCODE` - Retrieve information about a Discount Code
    `/edd discount DISCOUNTCODE $3.50` - Create or Update a Discount Code with a Flat Rate Discount
    `/edd discount DISCOUNTCODE 42%` - Create or Update a Discount Code with a Percentage Discount

*/edd customer*
Description: Outputs information about a Customer. You can use either their Customer ID or their Primary Email Address for this command.
Examples:
    `/edd customer 42`
    `/edd customer [email protected]`

*/edd help*
Description: Shows this Dialog. Optionally can show the Help Dialog for a Single Command.
Example: `/edd help`
Option(s): `sales`, `version`, `discount`, `customer`

• /edd ayuda
• /edd ventas
• /edd version
• /edd descuento
• /edd cliente

Configuración de invitaciones a equipos de Slack

Para habilitar esta función, tu propia cuenta de usuario de Slack debe tener los permisos necesarios para invitar usuarios. Esto normalmente está reservado para los administradores del equipo de Slack. De forma similar a los Mensajes Interactivos y las URL de Webhook, esto hereda algunas capacidades de tu usuario de Slack. Si no puedes invitar usuarios, tu aplicación de Slack tampoco podrá.

La capacidad de invitar automáticamente a clientes a tu equipo de Slack existe en la extensión, lo que requiere que las Notificaciones Interactivas y los Comandos de Barra Diagonal ya estén habilitados.

Una vez que hayas habilitado  Notificaciones Interactivas y Comandos de Barra Diagonal, aparecerá un nuevo botón en la configuración de EDD Slack para habilitar las Invitaciones de Equipo de Slack.

Una vez que hagas clic en este botón, aparecerá una ventana emergente similar a la que apareció cuando configuraste previamente los Mensajes Interactivos y los Comandos de Barra Diagonal. Esto se debe a que necesitas otorgar más permisos a tu Aplicación de Slack.

La ventana que aparece dirá que estás otorgando a la Aplicación de Slack la capacidad de acceder a todo el contenido y a todos los eventos en tiempo real. Esto se debe a que, para invitar a Clientes y Usuarios de Slack, tu Aplicación de Slack necesita todos los permisos de un Cliente de Slack completo. Esto solo se utiliza para invitar a Clientes a tu Equipo de Slack.

Una vez hecho esto, aparecen algunas opciones nuevas. Esto te permite habilitar las Invitaciones de Equipo de Slack para Clientes, así como las Invitaciones de Equipo de Slack para Vendedores (si la extensión de Envíos de Frontend está activa en tu sitio).

Todos los Usuarios de Slack recién invitados son invitados automáticamente a tu canal #general (o como lo hayas renombrado). Sin embargo, en esta pantalla, puedes definir canales públicos adicionales a los que te gustaría que fueran invitados. Obtiene todos los canales públicos de tu Equipo de Slack por ti, así que simplemente elige los que desees del menú desplegable.

El campo "Texto para Unirse al Equipo de Slack" ajusta el texto que se muestra al dar a un Cliente/Vendedor la opción de ser invitado a tu Equipo de Slack. Para los Clientes, se muestra en la página de Pago, y para los Vendedores en la página de registro de Vendedor.

You can also manually invite Customers from their Customer Page under the “Tools” tab and, if you are using the  Frontend Submissions extension, Vendors from their Vendor Page under the “Profile” tab in the WordPress Dashboard.

Integraciones de Slack de EDD Disponibles

Easy Digital Downloads – Frontend Submissions

Si Envíos de Frontend está activo, los siguientes Disparadores estarán disponibles:

• Nueva Solicitud de Vendedor
• Nuevo Producto de Vendedor (Si a los Vendedores se les da permiso para crear Productos)
• Producto de Vendedor Editado (Si a los Vendedores se les da permiso para editar sus Productos)
• Nuevo Formulario de Contacto de Vendedor Enviado
• Nuevo Feedback de Vendedor (Requiere que Reseñas también esté activo)

Soporte de Notificaciones Interactivas

Los siguientes Disparadores de Envíos de Frontend admiten Notificaciones Interactivas, siempre que se cumplan diferentes condiciones. Puedes Aprobar o Denegar las siguientes acciones de Vendedor directamente desde Slack:

• Nueva Solicitud de Vendedor (Si las nuevas Solicitudes de Vendedor no están configuradas para ser aprobadas automáticamente)
• Nuevo Producto de Vendedor (Si los nuevos Productos de Vendedor no están configurados para ser aprobados automáticamente)
• Producto de Vendedor Editado (Si las nuevas Ediciones de Productos de Vendedor no están configuradas para ser aprobadas automáticamente)

Easy Digital Downloads – Software Licensing

Si Software Licensing está activo, los siguientes Disparadores estarán disponibles:

• Nueva Clave de Licencia Generada
• License Key Activated
  • Nota: La activación manual desde la pantalla de Licencias no activa esto.
• License Key Deactivated
  • Nota: La desactivación manual desde la pantalla de Licencias no activa esto.
• Licencia Actualizada

Easy Digital Downloads – Commissions

Si Commissions está activo, el siguiente Disparador estará disponible:

• Nueva Comisión

Easy Digital Downloads – Purchase Limit

Si Purchase Limit está activo, el siguiente Disparador estará disponible:

• Límite de Compra Alcanzado

Comentarios sobre descargas (si están habilitados)

Aunque no es exactamente una "integración", por defecto Easy Digital Downloads no proporciona soporte para comentarios en descargas. Sin embargo, si lo habilita usted mismo o a través de otro plugin, el siguiente disparador estará disponible:

• Nuevo comentario en descarga

Soporte de Notificaciones Interactivas

Esta notificación interactiva es única en el sentido de que tiene dos versiones: una para cuando su sitio está configurado para aprobar comentarios manualmente y otra para cuando no lo está.

Si aprueba manualmente los comentarios en su sitio, tiene la capacidad de aprobar el comentario o marcarlo como spam. De lo contrario, solo tiene la capacidad de marcarlo como spam.

Nota sobre el almacenamiento en caché del lado del servidor:

Los disparadores de activación de licencias ahora son específicos para la activación/desactivación a través de la API web de EDD.

Esto puede causar problemas en algunas configuraciones del servidor debido al almacenamiento en caché del lado del servidor. Los parámetros de URL edd_action=activate y edd_action=deactivate deben excluirse del almacenamiento en caché en la página de inicio de su sitio para garantizar que todo funcione correctamente.

Easy Digital Downloads – Reseñas

Si Reseñas está activo, los siguientes disparadores estarán disponibles:

• Nueva reseña en descarga
• Nuevos comentarios del vendedor (requiere que Frontend Submissions también esté activo)

Easy Digital Downloads – Monitor de fraude

Si Monitor de fraude está activo, el siguiente disparador estará disponible:

• Compra fraudulenta sospechosa

Soporte de Notificaciones Interactivas

Puede utilizar notificaciones interactivas para marcar un pago como válido o marcarlo como fraude directamente desde Slack. Cuando lo haga, el registro adjunto al pago indicará la acción realizada y dirá que se realizó a través de EDD Slack y por qué usuario de Slack.

Easy Digital Downloads – Pagos recurrentes

Si Pagos recurrentes está activo, los siguientes disparadores estarán disponibles:

• Nueva suscripción creada
• Suscripción cancelada