Configurar webhooks en Apple Business
Una compañía asociada con acceso a la API puede recibir notificaciones push mediante un webhook para cambios de estado que impliquen diferentes recursos y eventos. Los tipos de notificaciones disponibles mediante los webhooks coinciden con los disponibles en la API de Notificaciones.
Nota: Para poder usar un webhook, debes tener acceso a la API de Apple Business y Apple debe aprobar cada entorno. Consulta Acceso compartido a la API.
Crear el primer webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización o Administrador de marketing.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
Selecciona API.
Selecciona
junto a “Añadir webhook” e introduce la siguiente información:Información
Descripción
Webhook
Puede contener letras, números y símbolos, excepto los siguientes:
; (punto y coma)
’ (apóstrofo)
[ (corchete izquierdo)
] (corchete derecho)
< (símbolo “menor que”)
> (símbolo “mayor que”)
Miembro del equipo
Un usuario con la función de Administrador de la organización o Administrador de marketing con el que se pueda contactar en caso de que se produzca un error en la conexión.
Entorno
Restricciones:
No puedes cambiar de entorno después de configurar un webhook
Un evento solo se puede usar una vez por entorno
URL de carga útil
Tiene que empezar con https://
Eventos
Se debe seleccionar al menos un recurso u otro evento
Nota: Si seleccionas Guardar, se envía un ping a la URL para verificar la conexión.
Selecciona Guardar.
Selecciona “Copiar” para copiar el secreto de cliente en el portapapeles.
Comparte el secreto de cliente con el administrador del webhook.
Cuando el administrador confirme que ha recibido el secreto de cliente, selecciona Aceptar.
Editar un webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización o Administrador de marketing.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
Selecciona API.
Selecciona
junto a Gestionar webhooks y selecciona un webhook de la lista.Puedes cambiar lo siguiente:
El nombre del webhook
El estado del webhook
El nombre de un usuario con el que se contacta en caso de que la conexión falle.
La URL de carga útil
Si es necesario, selecciona “Crear nuevo secreto de cliente” y, a continuación, selecciona Crear.
Nota: El secreto de cliente es una credencial de un solo uso que no se puede recuperar una vez finalizada la sesión, por lo que es necesario compartirlo y confirmarlo manualmente.
Comparte el secreto de cliente con el administrador del webhook.
Cuando el Administrador de la organización confirme que ha recibido el secreto de cliente, selecciona Aceptar.
Selecciona todos los recursos y eventos sobre los que quieras recibir notificaciones.
Nota: Los recursos que se usan en el mismo entorno de webhook no están disponibles para más de un webhook.
Selecciona Guardar.
Ver o cambiar el estado de un webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización o Administrador de marketing.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
Selecciona API.
Selecciona
junto a Gestionar webhooks y consulta la lista de webhooks.Cambia el estado del webhook para activarlo o desactivarlo.
Si desactivas un webhook, este dejará de recibir notificaciones.
Eliminar un webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización o Administrador de marketing.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
Selecciona API.
Selecciona
junto a Gestionar webhooks y consulta la lista de webhooks.Selecciona un webhook, desplázate hacia abajo y selecciona “Eliminar webhook”.
Selecciona Eliminar y, a continuación, Guardar.