UIP ou Webhooks

Syntaxe et options pour `uip ou webhooks`, qui gère les rappels HTTP d'Orchestrator déclenchés lors d'événements de plate-forme.

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 or .

Synthèse

uip or webhooks list         [-n <name>] [--enabled | --disabled] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or webhooks get          <webhook-key> [--all-fields]
uip or webhooks create       <name> --url <url> [-d <desc>] [--events <list>] [--secret <s>] [--allow-insecure-ssl]
uip or webhooks update       <webhook-key> [flags as for create] [--enabled | --disabled]
uip or webhooks delete       <webhook-key> --yes
uip or webhooks ping         <webhook-key>
uip or webhooks event-types

List

Lister des webhooks. Filtres: -n, --name, --enabled, --disabled (sont mutuellement exclusifs). --sort-by <field> trie les résultats (par défaut Id desc); --all-fields renvoie la réponse complète de l'API.

get

Obtenez les détails du Webhook par clé, y compris les événements auxquels vous êtes abonné et les paramètres SSL. --all-fields renvoie la réponse complète de l'API.

Créer

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

uip or webhooks create 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. Transmettez --enabled ou --disabled pour activer ou désactiver l'état du Webhook ( mutuellement exclusif).

uip or webhooks update <webhook-key> --disabled

Supprimer (Delete)

Supprimer un webhook par clé. Requiert -y, --yes — la CLI ne demande jamais d'opérations destructrices.

uip or webhooks delete <webhook-key> --yes

Résolution des problèmes

Envoyez une requête de test à l’URL du Webhook pour vérifier la connectivité. La livraison est asynchrone - une réponse réussie signifie que le ping a été mis en file d'attente, et non que le point de terminaison l'a reçu; confirmer la réception sur le point de terminaison lui-même.

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 or webhooks event-types

Codes de sortie

Voir Codes de sortie pour le contrat partagé. delete quitte 1 si -y, --yes est omis.

Voir également

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