oncall-engine/engine/apps/integrations/templates/html/integration_formatted_webhook.html
Michael Derynck 6b40f95033 World, meet OnCall!
Co-authored-by: Eve832 <eve.meelan@grafana.com>
    Co-authored-by: Francisco Montes de Oca <nevermind89x@gmail.com>
    Co-authored-by: Ildar Iskhakov <ildar.iskhakov@grafana.com>
    Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com>
    Co-authored-by: Julia <ferril.darkdiver@gmail.com>
    Co-authored-by: maskin25 <kengurek@gmail.com>
    Co-authored-by: Matias Bordese <mbordese@gmail.com>
    Co-authored-by: Matvey Kukuy <motakuk@gmail.com>
    Co-authored-by: Michael Derynck <michael.derynck@grafana.com>
    Co-authored-by: Richard Hartmann <richih@richih.org>
    Co-authored-by: Robby Milo <robbymilo@fastmail.com>
    Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
    Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
    Co-authored-by: Yulia Shanyrova <yulia.shanyrova@grafana.com>
2022-06-03 08:09:47 -06:00

47 lines
No EOL
1.9 KiB
HTML

<blockquote>
Formatted Webhook is primarily used for custom integrations using scripts.
Use any http client, for example curl, to send POST requests with body using the format in the example below:
</blockquote>
<p>
<h6>Body Fields Format:</h6>
<ul>
<li><code>alert_uid</code> [char][not required] - unique alert ID for grouping;</li>
<li><code>title</code> [char][not required] - title;</li>
<li><code>image_url</code> [char][not required] - url for image attached to alert;</li>
<li><code>state</code> [char][not required] - could be &quot;ok&quot; or &quot;alerting&quot;, helpful for auto-resolving;</li>
<li><code>link_to_upstream_details</code> [char][not required] - link back to your monitoring system;</li>
<li><code>message</code> [char][not required] - alert details;</li>
</ul>
</p>
<h6>Request example:</h6>
<p>
<pre>
curl -X POST \
{{ alert_receive_channel.integration_url }} \
-H 'Content-Type: Application/json' \
-d '{
&quot;alert_uid&quot;: &quot;08d6891a-835c-e661-39fa-96b6a9e26552&quot;,
&quot;title&quot;: &quot;The whole system is down&quot;,
&quot;image_url&quot;: &quot;https://upload.wikimedia.org/wikipedia/commons/e/ee/Grumpy_Cat_by_Gage_Skidmore.jpg&quot;,
&quot;state&quot;: &quot;alerting&quot;,
&quot;link_to_upstream_details&quot;: &quot;https://en.wikipedia.org/wiki/Downtime&quot;,
&quot;message&quot;: &quot;Smth happened. Oh no!&quot;
}'
</pre>
</p>
<h4>Next steps:</h4>
<p><ol>
<li>
1. Add the routes and escalations in <code class='code-inline'>Escalations settings</code>
</li>
<li>
2. Check grouping, auto-resolving, and rendering templates in
<code class='code-inline'>Alert Templates</code> Settings
</li>
<li>
3. Make sure all the users set up their <code class='code-inline'>Personal Notifications</code> Settings
on the <code class='code-inline'>Users</code> Page
</li>
</ol></p>