GITBOOK-1004: Tulip Docs

integrations/tulip.md

@@ -1,3 +1,106 @@
+---
+description: Create alerts in ilert from Tulip.
+---
+
 # Tulip Integration
 
-This page is still under construction and will be available soon.
+[Tulip.co](https://tulip.co/) is a platform dedicated to providing innovative solutions for manufacturing operations. At the heart of Tulip's offerings is its no-code platform, enabling frontline engineers and operators to create custom apps tailored to their specific needs without needing extensive programming skills. These apps can seamlessly integrate with existing tools and data sources, providing real-time insights and analytics to optimize manufacturing processes.
+
+ilert also offers an app for Tulip. This app allows users to send alerts to their ilert incident management platform, enabling them to notify on-call team members through various channels — including voice, push, SMS, or messenger notifications — about critical issues.
+
+## In ilert: Create a Tulip alert source <a href="#create-alert-source" id="create-alert-source"></a>
+
+1.  Go to **Alert sources** -> **Alert sources** and click on **Create new alert source**\
+
+
+    <figure><img src="../.gitbook/assets/Screenshot 2023-08-28 at 10.21.10.png" alt=""><figcaption></figcaption></figure>
+2.  Search for **Tulip** in the search field, click on the Amazon Cloudwatch tile and click on **Next**. \
+
+
+    <figure><img src="../.gitbook/assets/Screenshot 2023-08-28 at 10.24.23.png" alt=""><figcaption></figcaption></figure>
+3. Give your alert source a name, optionally assign teams, and click **Next**.
+4.  Select an **escalation policy** by creating a new one or assigning an existing one.\
+
+
+    <figure><img src="../.gitbook/assets/Screenshot 2023-08-28 at 11.37.47.png" alt=""><figcaption></figcaption></figure>
+5.  Select your [Alert grouping](../alerting/alert-sources.md#alert-grouping) preference and click **Continue setup**. You may click **Do not group alerts** for now and change it later. \
+
+
+    <figure><img src="../.gitbook/assets/Screenshot 2023-08-28 at 11.38.24.png" alt=""><figcaption></figcaption></figure>
+6. The next page show additional settings such as customer alert templates or notification prioritiy. Click on **Finish setup** for now.
+7.  On the final page, an API key and / or webhook URL will be generated that you will need later in this guide.
+
+
+
+    <figure><img src="../.gitbook/assets/Screenshot 2023-08-28 at 11.47.34 (1).png" alt=""><figcaption></figcaption></figure>
+
+## In Tulip: Add and edit the ilert Tulip app <a href="#create-alert-source" id="create-alert-source"></a>
+
+1. Search for the ilert App in the [Tulip App Library](https://tulip.co/library-search/?desc=ilert).
+
+<figure><img src="../.gitbook/assets/tulip-1.png" alt="" width="563"><figcaption></figcaption></figure>
+
+2. Go to **Apps** **-> Connectors**.
+
+<figure><img src="../.gitbook/assets/tulip-2.png" alt="" width="498"><figcaption></figcaption></figure>
+
+3. Select the ilert connector.
+
+<figure><img src="../.gitbook/assets/tulip-4.png" alt="" width="563"><figcaption></figcaption></figure>
+
+3. In Tulip we can now configure basic and advanced alerts.\
+   Basic alert: Plain alert containing a summary and some details.\
+   Advanced alert: Contains more information such as event types and alerting key. Alerts have associations and can be accepted or resolved.
+
+{% tabs %}
+{% tab title="Basic alerts" %}
+1. Select the "Send a basic alert to ilert" connector and click on **Edit**.
+
+<figure><img src="../.gitbook/assets/tulip-5.png" alt="" width="563"><figcaption></figcaption></figure>
+
+2. Enter the previously created Alertsource URL into the URL field on the top.
+
+<figure><img src="../.gitbook/assets/tulip-7.png" alt="" width="563"><figcaption></figcaption></figure>
+{% endtab %}
+
+{% tab title="Advanced alerts" %}
+1. Select the "Send an advanced alert to ilert" connector and click on **Edit**.
+
+<figure><img src="../.gitbook/assets/tulip-6.png" alt="" width="563"><figcaption></figcaption></figure>
+
+2. Enter the previously created Alertsource URL into the URL field on the top.
+
+<figure><img src="../.gitbook/assets/tulip-7.png" alt="" width="563"><figcaption></figcaption></figure>
+{% endtab %}
+{% endtabs %}
+
+4. Switch back to Apps and Select "ilert Alerting App."
+5. Click on **Run** to run the application.
+
+<figure><img src="../.gitbook/assets/tulip-8.png" alt="" width="563"><figcaption></figcaption></figure>
+
+6. Click on **Begin**.
+
+<figure><img src="../.gitbook/assets/tulip-9.png" alt="" width="563"><figcaption></figcaption></figure>
+
+{% hint style="info" %}
+To use this feature, you need to set up the "Send an advanced alert to ilert" connector in Step 3.
+{% endhint %}
+
+7. If you want to switch to advanced alerting, click on **Advanced alert**.
+
+{% hint style="info" %}
+Providing the **Event types** ACCEPT or RESOLVE requires to enter any unique **Alert key**. Associated alert with the same Alert key will then change its status.
+{% endhint %}
+
+<figure><img src="../.gitbook/assets/tulip-11.png" alt="" width="563"><figcaption></figcaption></figure>
+
+## FAQ
+
+**Will alerts in ilert be resolved automatically?**
+
+Yes, as soon as the ilert Alerting App in Tulip sends a "RESOLVE" alert, the associated alert is automatically resolved in ilert.
+
+**Will alerts in ilert be accepted automatically?**
+
+Yes, as soon as the ilert Alerting App in Tulip sends an "ACCEPT" alert, the associated alert is automatically resolved in ilert.