Workflow Automation - Add Form Trigger (#3209)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 88f24b7

Author: api-clients-generation-pipeline[bot]

_sources/datadog_api_client.v2.model.rst.txt

@@ -11022,6 +11022,20 @@ datadog\_api\_client.v2.model.fleet\_schedules\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.form\_trigger module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_trigger
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_trigger\_wrapper module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_trigger_wrapper
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.formula\_limit module
 ---------------------------------------------------
 

datadog_api_client.html

@@ -4149,6 +4149,8 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedule_response">datadog_api_client.v2.model.fleet_schedule_response module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedule_status">datadog_api_client.v2.model.fleet_schedule_status module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedules_response">datadog_api_client.v2.model.fleet_schedules_response module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger">datadog_api_client.v2.model.form_trigger module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger_wrapper">datadog_api_client.v2.model.form_trigger_wrapper module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.formula_limit">datadog_api_client.v2.model.formula_limit module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.framework_handle_and_version_response_data">datadog_api_client.v2.model.framework_handle_and_version_response_data module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.freshservice_api_key">datadog_api_client.v2.model.freshservice_api_key module</a></li>

datadog_api_client.v2.html

@@ -8873,6 +8873,14 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.fleet_schedules_response.FleetSchedulesResponse"><code class="docutils literal notranslate"><span class="pre">FleetSchedulesResponse</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger">datadog_api_client.v2.model.form_trigger module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.form_trigger.FormTrigger"><code class="docutils literal notranslate"><span class="pre">FormTrigger</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger_wrapper">datadog_api_client.v2.model.form_trigger_wrapper module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.form_trigger_wrapper.FormTriggerWrapper"><code class="docutils literal notranslate"><span class="pre">FormTriggerWrapper</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.formula_limit">datadog_api_client.v2.model.formula_limit module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.formula_limit.FormulaLimit"><code class="docutils literal notranslate"><span class="pre">FormulaLimit</span></code></a></li>
 </ul>

datadog_api_client.v2.model.html

@@ -10389,6 +10389,18 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.form_trigger" class="md-nav__link">datadog_api_client.v2.model.form_trigger module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.form_trigger.FormTrigger" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">FormTrigger</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.form_trigger_wrapper" class="md-nav__link">datadog_api_client.v2.model.form_trigger_wrapper module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.form_trigger_wrapper.FormTriggerWrapper" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">FormTriggerWrapper</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.formula_limit" class="md-nav__link">datadog_api_client.v2.model.formula_limit module</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.model.formula_limit.FormulaLimit" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">FormulaLimit</span></code></a>
@@ -64179,6 +64191,45 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 </section>
+<section id="module-datadog_api_client.v2.model.form_trigger">
+<span id="datadog-api-client-v2-model-form-trigger-module"></span><h2 id="module-datadog_api_client.v2.model.form_trigger">datadog_api_client.v2.model.form_trigger module<a class="headerlink" href="#module-datadog_api_client.v2.model.form_trigger" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.model.form_trigger.FormTrigger">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.model.form_trigger.FormTrigger" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Trigger a workflow from a Form.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>form_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The form UUID.</p>
+</dd>
+</dl>
+</dd></dl>
+</section>
+<section id="module-datadog_api_client.v2.model.form_trigger_wrapper">
+<span id="datadog-api-client-v2-model-form-trigger-wrapper-module"></span><h2 id="module-datadog_api_client.v2.model.form_trigger_wrapper">datadog_api_client.v2.model.form_trigger_wrapper module<a class="headerlink" href="#module-datadog_api_client.v2.model.form_trigger_wrapper" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.model.form_trigger_wrapper.FormTriggerWrapper">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormTriggerWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.model.form_trigger_wrapper.FormTriggerWrapper" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormTriggerWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormTriggerWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Schema for a Form-based trigger.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>form_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.form_trigger.FormTrigger" title="datadog_api_client.v2.model.form_trigger.FormTrigger"><em>FormTrigger</em></a>) – Trigger a workflow from a Form.</p></li>
+<li><p><strong>start_step_names</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – A list of steps that run first after a trigger fires.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
 <section id="module-datadog_api_client.v2.model.formula_limit">
 <span id="datadog-api-client-v2-model-formula-limit-module"></span><h2 id="module-datadog_api_client.v2.model.formula_limit">datadog_api_client.v2.model.formula_limit module<a class="headerlink" href="#module-datadog_api_client.v2.model.formula_limit" title="Link to this heading">¶</a></h2>
 <dl class="py class">
@@ -125528,6 +125579,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <li><p><strong>database_monitoring_trigger</strong> (<em>dict</em>) – Trigger a workflow from Database Monitoring.</p></li>
 <li><p><strong>datastore_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger" title="datadog_api_client.v2.model.datastore_trigger.DatastoreTrigger"><em>DatastoreTrigger</em></a>) – Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
 <li><p><strong>dashboard_trigger</strong> (<em>dict</em>) – Trigger a workflow from a Dashboard.</p></li>
+<li><p><strong>form_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.form_trigger.FormTrigger" title="datadog_api_client.v2.model.form_trigger.FormTrigger"><em>FormTrigger</em></a>) – Trigger a workflow from a Form.</p></li>
 <li><p><strong>github_webhook_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.github_webhook_trigger.GithubWebhookTrigger" title="datadog_api_client.v2.model.github_webhook_trigger.GithubWebhookTrigger"><em>GithubWebhookTrigger</em></a>) – Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a <cite>webhookSecret</cite>. In your GitHub Webhook Settings, set the Payload URL to “base_url”/api/v2/workflows/”workflow_id”/webhook?orgId=”org_id”, select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.</p></li>
 <li><p><strong>incident_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.incident_trigger.IncidentTrigger" title="datadog_api_client.v2.model.incident_trigger.IncidentTrigger"><em>IncidentTrigger</em></a>) – Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.</p></li>
 <li><p><strong>monitor_trigger</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.monitor_trigger.MonitorTrigger" title="datadog_api_client.v2.model.monitor_trigger.MonitorTrigger"><em>MonitorTrigger</em></a>) – Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.</p></li>

genindex.html

@@ -22853,6 +22853,20 @@ <h2 id="D">D</h2>
 
       <ul>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedules_response">module</a>
+</li>
+      </ul></li>
+      <li>
+    datadog_api_client.v2.model.form_trigger
+
+      <ul>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger">module</a>
+</li>
+      </ul></li>
+      <li>
+    datadog_api_client.v2.model.form_trigger_wrapper
+
+      <ul>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger_wrapper">module</a>
 </li>
       </ul></li>
       <li>
@@ -23807,15 +23821,15 @@ <h2 id="D">D</h2>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.global_incident_settings_request">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     datadog_api_client.v2.model.global_incident_settings_response
 
       <ul>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.global_incident_settings_response">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     datadog_api_client.v2.model.global_incident_settings_type
 
@@ -43935,10 +43949,10 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.fleet_agent_versions_response.FleetAgentVersionsResponse">FleetAgentVersionsResponse (class in datadog_api_client.v2.model.fleet_agent_versions_response)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.fleet_automation_api.FleetAutomationApi">FleetAutomationApi (class in datadog_api_client.v2.api.fleet_automation_api)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.fleet_configuration_file.FleetConfigurationFile">FleetConfigurationFile (class in datadog_api_client.v2.model.fleet_configuration_file)</a>
 </li>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.fleet_configuration_layer.FleetConfigurationLayer">FleetConfigurationLayer (class in datadog_api_client.v2.model.fleet_configuration_layer)</a>
@@ -44018,6 +44032,10 @@ <h2 id="F">F</h2>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.fleet_schedule_status.FleetScheduleStatus">FleetScheduleStatus (class in datadog_api_client.v2.model.fleet_schedule_status)</a>
 </li>
       <li><a href="datadog_api_client.html#datadog_api_client.exceptions.ForbiddenException">ForbiddenException</a>
+</li>
+      <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.form_trigger.FormTrigger">FormTrigger (class in datadog_api_client.v2.model.form_trigger)</a>
+</li>
+      <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.form_trigger_wrapper.FormTriggerWrapper">FormTriggerWrapper (class in datadog_api_client.v2.model.form_trigger_wrapper)</a>
 </li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.formula_and_function_apm_dependency_stat_name.FormulaAndFunctionApmDependencyStatName">FormulaAndFunctionApmDependencyStatName (class in datadog_api_client.v1.model.formula_and_function_apm_dependency_stat_name)</a>
 </li>
@@ -52640,6 +52658,10 @@ <h2 id="M">M</h2>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedule_status">datadog_api_client.v2.model.fleet_schedule_status</a>
 </li>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedules_response">datadog_api_client.v2.model.fleet_schedules_response</a>
+</li>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger">datadog_api_client.v2.model.form_trigger</a>
+</li>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger_wrapper">datadog_api_client.v2.model.form_trigger_wrapper</a>
 </li>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.formula_limit">datadog_api_client.v2.model.formula_limit</a>
 </li>

objects.inv

@@ -14322,6 +14322,16 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.fleet_schedules_response"><code class="xref">datadog_api_client.v2.model.fleet_schedules_response</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger"><code class="xref">datadog_api_client.v2.model.form_trigger</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.form_trigger_wrapper"><code class="xref">datadog_api_client.v2.model.form_trigger_wrapper</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;