Creación de webhooks para Amazon Chime - Amazon Chime
Solución de errores relacionados con los webhooks

Debe ser administrador del sistema Amazon Chime para completar los pasos de esta guía. Si necesita ayuda con el cliente de escritorio, la aplicación web o la aplicación móvil de Amazon Chime, consulte Obtener asistencia en la Guía del usuario de Amazon Chime.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Creación de webhooks para Amazon Chime

Los webhooks permiten que las aplicaciones web se comuniquen entre sí en tiempo real. Por lo general, los webhooks envían notificaciones cuando se produce una acción. Por ejemplo, supongamos que gestiona un sitio de compras en línea. Webhooks puede avisarle cuando un cliente añada artículos a un carrito de compras, pague un pedido o envíe un comentario. Los webhooks no necesitan tanta programación como las aplicaciones tradicionales y no utilizan tanta potencia de procesamiento. Sin un webhook, un programa tiene que buscar datos con frecuencia para poder obtenerlos en tiempo real. Con un webhook, la aplicación de envío publica los datos inmediatamente.

Los webhooks entrantes que cree pueden enviar mensajes mediante programación a salas de chat de Amazon Chime. Por ejemplo, un webhook puede notificar a un equipo de atención al cliente la creación de una nueva incidencia de alta prioridad y añadir un enlace a la incidencia en la sala de chat.

Puede aplicar formato a los mensajes de los webhooks mediante el marcado e incluir emojis. Los enlaces de HTTP y las direcciones de correo electrónico se representan como enlaces en los que puede hacer clic. Los mensajes también pueden incluir anotaciones @All y @Present para alertar a todos los miembros y a los miembros presentes de una sala de chat, respectivamente. Para @mencionar directamente a un asistente de una sala de chat, use su alias o su dirección de correo electrónico completa. Por ejemplo, @alias o @alias@domain.com.

Los webhooks solo pueden formar parte de una sala de chat y no se pueden compartir. Los administradores de salas de chat de Amazon Chime pueden añadir hasta 10 webhooks para cada sala de chat.

Después de crear un webhook, podrá integrarlo en una sala de chat de Amazon Chime, tal como se muestra en el siguiente procedimiento.

Para integrar un webhook en una sala de chat

  1. Obtenga la URL del webhook del administrador de la sala de chat. Para obtener más información, consulte Añadir webhooks a una sala de chat en la Guía del usuario de Amazon Chime.

  2. Use la URL del webhook del script o la aplicación que creó para enviar mensajes a la sala de chat:

    1. La URL acepta una solicitud HTTP POST.

    2. Los webhooks de Amazon Chime aceptan una carga JSON con una única clave Contenido. A continuación se muestra un ejemplo de comando Curl con una carga de muestra:

      curl -X POST "<Insert your webhook URL here>" -H "Content-Type:application/json" --data '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: marymajor@example.com All member callout: @All All Present member callout: @Present"}'

      A continuación, se muestra un comando de PowerShell de ejemplo para usuarios de Windows:

      Invoke-WebRequest -Uri '<Insert your webhook URL here>' -Method 'Post' -ContentType 'application/JSON' -Body '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: marymajor@example.com All member callout: @All All Present member callout: @Present"}'

Una vez que el programa externo envía la solicitud HTTP POST a la URL del webhook, el servidor confirma que el webhook es válido y que tiene asignada una sala de chat. El webhook aparece en la lista de la sala de chat con un icono de webhook junto a su nombre. Los mensajes de la sala de chat enviados por el webhook aparecen en la sala de chat con el nombre del webhook seguido de (Webhook).

nota

CORS no está habilitado actualmente para los webhooks.

Solución de errores relacionados con los webhooks

A continuación se muestra una lista de los errores relacionados con los webhooks:

  • El límite de frecuencia de webhook entrante para cada webhook es de 1 TPS por cada sala de chat. Si se produce una limitación controlada, se genera un error HTTP 429.

  • Los mensajes publicadas por un webhook deben ser de 4 KB o menos. Si la carga del mensaje es más grande, se produce un error HTTP 413.

  • Los mensajes publicados por un webhook con anotaciones @All y @Present solo funcionan en salas de chat con un máximo de 50 miembros. Si hay más de 50 miembros, se devuelve un error HTTP 400.

  • Si la URL del webhook se regenera, cuando se utiliza la URL antigua se produce un error HTTP 404.

  • Si se elimina el webhook en una sala, cuando se utiliza la URL antigua se produce un error HTTP 404.

  • Las URL de webhook no válidas generan errores HTTP 403.

  • Si el servicio no está disponible, el usuario recibe un error HTTP 503 en la respuesta.