webhooks de ressources UiP

Gérer les webhooks Orchestrator — Rappels HTTP déclenchés sur les événements de la plateforme (achèvement de la tâche, échec de l'élément de la file d'attente, etc.). Les Webhooks sont à l’échelle du locataire.

Pour les conventions multi-ressources (authentification, types de clés, enveloppe de sortie), consultez la vue d’ensembleuip resource .

Synthèse

uip resource webhooks list         [-n <name>] [--enabled | --disabled]
uip resource webhooks get          <webhook-key>
uip resource webhooks create       --name <n> --url <url> [-d <desc>] [--events <list>] [--secret <s>] [--allow-insecure-ssl]
uip resource webhooks update       <webhook-key> [flags as for create]
uip resource webhooks delete       <webhook-key>
uip resource webhooks ping         <webhook-key>
uip resource webhooks event-types

List

Lister des webhooks. Filtres: -n, --name, --enabled, --disabled (sont mutuellement exclusifs).

get

Obtenez les détails du Webhook par clé, y compris les événements auxquels vous êtes abonné et les paramètres SSL.

Créer

Créez un webhook. --name requis, --url. Facultatif -d, --description, --events <comma-list> (omettre pour s'abonner à tous les types d'événements), --secret, --allow-insecure-ssl.

uip resource webhooks create --name JobAlerts \
  --url https://hooks.example.com/uipath \
  --events "job.completed,job.faulted"

Mettre à jour

Mettre à jour par clé. Fournir --events fait basculer le Webhook de l’abonnement à tout le monde à la liste donnée.

Supprimer (Delete)

Supprimer un webhook par clé.

Résolution des problèmes

Envoyez une requête de test à l’URL du Webhook pour vérifier la connectivité.

Types d'événements

Répertorie chaque type d’événement auquel un Webhook peut s’abonner. Utilisez les noms renvoyés avec create --events ou update --events.

uip resource webhooks event-types

Voir également

• Vue d’ensemble deuip resource — conventions partagées pour chaque uip resource verbe.
• Procédures: gérer les ressources et les files d'attente Orchestrator — modèles de création de webhook.