{"id":74747,"date":"2023-06-05T13:12:17","date_gmt":"2023-06-05T17:12:17","guid":{"rendered":"https:\/\/jumpcloud.com\/?post_type=support&#038;p=74747"},"modified":"2023-06-05T13:12:17","modified_gmt":"2023-06-05T17:12:17","slug":"use-command-triggers","status":"publish","type":"support","link":"https:\/\/jumpcloud.com\/support\/use-command-triggers","title":{"rendered":"Use Command Triggers"},"content":{"rendered":"\n<p>To use command triggers, enter a trigger name associated with a command that you create in <strong>DEVICE MANAGEMENT<\/strong> &gt; <strong>Commands<\/strong>, and then save the command.<\/p>\n\n\n\n<p>When JumpCloud receives a webhook containing the trigger name, JumpCloud will automatically execute any command with that trigger name, in parallel, across all the servers defined in the saved commands.<\/p>\n\n\n\n<p>This lets you automate some very powerful actions on your network, such as:<\/p>\n\n\n\n<ul>\n<li>Remotely restart your web servers, all at the same time<\/li>\n\n\n\n<li>Integrate with your monitoring solution to join actions with monitoring thresholds, such as disks filling up, or performance issues<\/li>\n\n\n\n<li>Remotely start a database backup\n<ul>\n<li><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>\u2026 and much, much more.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Basic Trigger Execution<\/h2>\n\n\n\n<p>To execute a trigger, form a webhook request as follows (shown below as a curl command, run from bash and as a PowerShell command):<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>!\/bin\/bash<br>jumpCloudAPIKey=&#8221;&#8221;<br>triggerName=&#8221;myTriggerName&#8221;<br>curl &#8211;silent \\<br>-X &#8216;POST&#8217; \\<br>-H &#8220;x-api-key: ${jumpCloudAPIKey}&#8221; \\<br>&#8220;https:\/\/console.jumpcloud.com\/api\/command\/trigger\/${triggerName}&#8221;<br>PS \/PowerShell&gt;<br>$APIkey = &#8216;jumpCloudAPIKey&#8217;<br>$triggerName = &#8216;myTriggerName&#8217;<br>$TriggerURL = &#8220;https:\/\/console.jumpcloud.com\/api\/command\/trigger\/$triggerName&#8221;<br>$hdrs = @{}<br>$hdrs.Add(&#8220;Accept&#8221;,&#8221;application\/json&#8221;)<br>$hdrs.Add(&#8220;X-API-KEY&#8221;,&#8221;$APIkey&#8221;)<br>Invoke-RestMethod -Method POST -Uri $TriggerURL -Header $hdrs<\/p>\n<\/div><\/div>\n\n\n\n<p>Upon receipt of this request, assuming the API key is correct and that one or more commands are set to run based on the trigger name &#8220;myTriggerName&#8221;, JumpCloud will start all commands that match the trigger name &#8220;myTriggerName&#8221;.<\/p>\n\n\n\n<p>To obtain your API key, select your user name in the upper right corner of the JumpCloud console, and select <strong>My API Key<\/strong>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Sending Data with a Trigger<\/h2>\n\n\n\n<p>JumpCloud allows you to post a JSON object with a trigger. JumpCloud will provide each top level data object as an environment variable to the triggered command. This allows you to do things like:<\/p>\n\n\n\n<ul>\n<li>Pass the source IP address of an attack in progress and automatically take action to block it.<\/li>\n\n\n\n<li>Pass the name of a service to be restarted<\/li>\n\n\n\n<li>Pass a query to script to execute<\/li>\n<\/ul>\n\n\n\n<p>\u2026 and much more.<\/p>\n\n\n\n<p>To send data to a Trigger, you change the webhook call to include as part of the body of the POST request, a well-formatted JSON object.<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>!\/bin\/bash<br>jumpCloudAPIKey=&#8221;my_user_API_key&#8221;<br>triggerName=&#8221;myTriggerName&#8221;<br>curl &#8211;silent \\<br>-X &#8216;POST&#8217; \\<br>-H &#8220;x-api-key: ${jumpCloudAPIKey}&#8221; \\<br>-H &#8216;Content-Type: application\/json&#8217; \\<br>-d &#8216;{ &#8220;srcip&#8221;:&#8221;192.168.2.32&#8243; }&#8217; \\<br>&#8220;https:\/\/console.jumpcloud.com\/api\/command\/trigger\/${triggerName}&#8221;<br>Remember that only the top level objects are provided to the command, any sub-objects or arrays will be sent as &#8220;[object Object]&#8221;.<\/p>\n<\/div><\/div>\n\n\n\n<p>For example, sending:<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>{ &#8220;srcip&#8221;:&#8221;192.168.2.32&#8243;, &#8220;test&#8221;:{ &#8220;bob&#8221;:&#8221;1&#8243;, &#8220;jane&#8221;:&#8221;3&#8243;} }<\/p>\n<\/div><\/div>\n\n\n\n<p>Results in the following environment variables in your command:<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>test=&#8221;[object Object]&#8221;<br>srcip=&#8221;192.168.2.32&#8243;<\/p>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>To use command triggers, enter a trigger name associated with a command that you create in DEVICE MANAGEMENT &gt; Commands, [&hellip;]<\/p>\n","protected":false},"author":206,"featured_media":0,"template":"","meta":{"_acf_changed":false,"_oasis_is_in_workflow":0,"_oasis_original":0,"_oasis_task_priority":"","inline_featured_image":false,"footnotes":""},"support_category":[2895,2852],"support_tag":[],"coauthors":[2842],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v22.9 (Yoast SEO v22.9) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Use Command Triggers - JumpCloud<\/title>\n<meta name=\"description\" content=\"Learn how to leverage command triggers to automate powerful actions on your network.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jumpcloud.com\/support\/use-command-triggers\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Use Command Triggers\" \/>\n<meta property=\"og:description\" content=\"Learn how to leverage command triggers to automate powerful actions on your network.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jumpcloud.com\/support\/use-command-triggers\" \/>\n<meta property=\"og:site_name\" content=\"JumpCloud\" \/>\n<meta property=\"og:image\" content=\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png\" \/>\n\t<meta property=\"og:image:width\" content=\"890\" \/>\n\t<meta property=\"og:image:height\" content=\"525\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n\t<meta name=\"twitter:label2\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data2\" content=\"pamkellman\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/jumpcloud.com\/support\/use-command-triggers\",\"url\":\"https:\/\/jumpcloud.com\/support\/use-command-triggers\",\"name\":\"Use Command Triggers - JumpCloud\",\"isPartOf\":{\"@id\":\"https:\/\/jumpcloud.com\/#website\"},\"datePublished\":\"2023-06-05T17:12:17+00:00\",\"dateModified\":\"2023-06-05T17:12:17+00:00\",\"description\":\"Learn how to leverage command triggers to automate powerful actions on your network.\",\"breadcrumb\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/use-command-triggers#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/jumpcloud.com\/support\/use-command-triggers\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/jumpcloud.com\/support\/use-command-triggers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/jumpcloud.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support\",\"item\":\"https:\/\/jumpcloud.com\/support\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Use Command Triggers\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/jumpcloud.com\/#website\",\"url\":\"https:\/\/jumpcloud.com\/\",\"name\":\"JumpCloud\",\"description\":\"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.\",\"publisher\":{\"@id\":\"https:\/\/jumpcloud.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/jumpcloud.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/jumpcloud.com\/#organization\",\"name\":\"JumpCloud\",\"url\":\"https:\/\/jumpcloud.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"contentUrl\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"width\":598,\"height\":101,\"caption\":\"JumpCloud\"},\"image\":{\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Use Command Triggers - JumpCloud","description":"Learn how to leverage command triggers to automate powerful actions on your network.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jumpcloud.com\/support\/use-command-triggers","og_locale":"en_US","og_type":"article","og_title":"Use Command Triggers","og_description":"Learn how to leverage command triggers to automate powerful actions on your network.","og_url":"https:\/\/jumpcloud.com\/support\/use-command-triggers","og_site_name":"JumpCloud","og_image":[{"width":890,"height":525,"url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes","Written by":"pamkellman"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/jumpcloud.com\/support\/use-command-triggers","url":"https:\/\/jumpcloud.com\/support\/use-command-triggers","name":"Use Command Triggers - JumpCloud","isPartOf":{"@id":"https:\/\/jumpcloud.com\/#website"},"datePublished":"2023-06-05T17:12:17+00:00","dateModified":"2023-06-05T17:12:17+00:00","description":"Learn how to leverage command triggers to automate powerful actions on your network.","breadcrumb":{"@id":"https:\/\/jumpcloud.com\/support\/use-command-triggers#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jumpcloud.com\/support\/use-command-triggers"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/jumpcloud.com\/support\/use-command-triggers#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/jumpcloud.com\/"},{"@type":"ListItem","position":2,"name":"Support","item":"https:\/\/jumpcloud.com\/support"},{"@type":"ListItem","position":3,"name":"Use Command Triggers"}]},{"@type":"WebSite","@id":"https:\/\/jumpcloud.com\/#website","url":"https:\/\/jumpcloud.com\/","name":"JumpCloud","description":"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.","publisher":{"@id":"https:\/\/jumpcloud.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jumpcloud.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/jumpcloud.com\/#organization","name":"JumpCloud","url":"https:\/\/jumpcloud.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/","url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","contentUrl":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","width":598,"height":101,"caption":"JumpCloud"},"image":{"@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/74747"}],"collection":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support"}],"about":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/types\/support"}],"author":[{"embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/users\/206"}],"version-history":[{"count":3,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/74747\/revisions"}],"predecessor-version":[{"id":77870,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/74747\/revisions\/77870"}],"wp:attachment":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/media?parent=74747"}],"wp:term":[{"taxonomy":"support_category","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_category?post=74747"},{"taxonomy":"support_tag","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_tag?post=74747"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/coauthors?post=74747"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}