Configurar webhooks en Apple Business Connect
Las compañías asociadas con acceso de API pueden recibir notificaciones push mediante un webhook para ver los cambios de estado que competen a distintos recursos y eventos. Estos tipos de notificación que se reciben mediante webhooks son iguales que los de la API de notificaciones.
Nota: Para usar un webhook, debes tener acceso de API a Apple Business Connect y todos los entornos deben estar aprobados por Apple. Consulta Solicitar acceso de API.
Crear el primer webhook
Si todavía no has iniciado sesión en Apple Business Connect, hazlo utilizando un usuario que tenga la función de administrador.
Si eres administrador de más de una compañía, selecciona la compañía en cuestión en la lista
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
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 miembro del equipo con la función de administrador o desarrollador con el que se contacta si falla la conexión
Entorno
Restricciones:
No puedes cambiar de entorno después de configurar un webhook
Los eventos solo se pueden usar una vez por entorno
URL de carga útil
Debe empezar por https://
Eventos
Se debe seleccionar al menos un recurso u otro evento
Nota: Después de añadir la información del webhook, se envía un ping a la URL para verificar la conexión.
Selecciona Guardar.
Selecciona el botón Copiar y copia el secreto del cliente en el portapapeles.
Comparte el secreto del cliente con el administrador del webhook.
Cuando el administrador haya confirmado que ha recibido el secreto del cliente, selecciona Aceptar.
Modificar un webhook
Si todavía no has iniciado sesión en Apple Business Connect, hazlo utilizando un usuario que tenga la función de administrador.
Si eres administrador de más de una compañía, selecciona la compañía en cuestión en la lista
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
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 miembro del equipo con el que se contacta en caso de que la conexión falle
La URL de carga útil
Si es necesario, selecciona la opción para crear un nuevo secreto del cliente y luego selecciona Crear.
Comparte el secreto del cliente con el administrador del webhook.
Cuando el administrador haya confirmado que ha recibido el secreto del 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
Si todavía no has iniciado sesión en Apple Business Connect, hazlo utilizando un usuario que tenga la función de administrador.
Si eres administrador de más de una compañía, selecciona la compañía en cuestión en la lista
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
Selecciona
junto a Gestionar webhooks y echa un vistazo a la lista de webhooks.Cambia el estado del webhook para activarlo o desactivarlo.
Si desactivas un webhook, se dejan de enviar notificaciones al mismo.
Eliminar un webhook
Si todavía no has iniciado sesión en Apple Business Connect, hazlo utilizando un usuario que tenga la función de administrador.
Si eres administrador de más de una compañía, selecciona la compañía en cuestión en la lista
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
Selecciona
junto a Gestionar webhooks y echa un vistazo a la lista de webhooks.Selecciona un webhook, desplázate hacia abajo y selecciona Eliminar webhook.
Selecciona Eliminar y luego Guardar.