UIP oder Webhooks

Syntax und Optionen für „uip oder webhooks“, die Orchestrator-HTTP-Rückrufe verwalten, die bei Plattformereignissen ausgelöst werden.

Orchestrator- Webhooks verwalten – HTTP-Rückrufe, die bei Plattformereignissen ausgelöst werden (Auftragsabschluss, Fehler bei Warteschlangenelementen usw.). Webhooks haben einen Mandanten-Scope.

Die ressourcenübergreifenden Konventionen (Authentifizierung, Schlüsseltypen, Ausgabeumschlag) finden Sie in der uip or -Übersicht.

Zusammenfassung

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

Liste

Listen Sie Webhooks auf. Filter: -n, --name, --enabled, --disabled (ausschließend). --sort-by <field> sortiert Ergebnisse (Standard: Id desc); --all-fields gibt die vollständige API-Antwort zurück.

get

Rufen Sie Webhook-Details nach Schlüssel ab, einschließlich abonnierter Ereignisse und SSL-Einstellungen. --all-fields gibt die vollständige API-Antwort zurück.

Erstellen

Erstellen Sie einen Webhook. Erfordert <name> und --url. Optional -d, --description, --events <comma-list> (es lassen Sie alle Ereignistypen abonnieren), --secret, --allow-insecure-ssl.

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

Aktualisieren

Nach Schlüssel aktualisieren. Wenn Sie --events angeben, wird der Webhook von „Abonnement-für-Alle“ auf die angegebene Liste umgestellt. Übergeben Sie --enabled oder --disabled, um den Status des Webhooks umzuschalten ( sodass sich diese gegenseitig ausschließen).

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

Löschen

Löschen Sie einen Webhook nach Schlüssel. Erfordert -y, --yes – die CLI fordert nie zu destruktiven Vorgängen auf.

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

Ping

Senden Sie einen Test-Ping an die Webhook-URL, um die Verbindung zu überprüfen. Die Bereitstellung ist asynchron – eine erfolgreiche Antwort bedeutet, dass das Ping in die Warteschlange gestellt wurde und nicht, dass der Endpunkt es empfangen hat; Bestätigen Sie den Empfang am Endpunkt selbst.

Ereignistypen

Listen Sie jeden Ereignistyp auf, den ein Webhook abonnieren kann. Verwenden Sie die zurückgegebenen Namen mit create --events oder update --events.

uip or webhooks event-types

Exitcodes

Siehe Austrittscodes für den gemeinsamen Vertrag. delete beendet 1, wenn -y, --yes weggelassen wird.

Siehe auch

• uip or Übersicht – gemeinsame Konventionen für jedes uip or -Verb.
• So: Verwalten von Orchestrator-Assets und Warteschlangen – Webhook-Erstellungsmuster.