Webhooks docs (#172)

* patch - fixing webhook docs
coralogix · Nov 16, 2023 · fab3ca8 · fab3ca8
1 parent 267aded
commit fab3ca8
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 8 deletions.
diff --git a/docs/data-sources/webhook.md b/docs/data-sources/webhook.md
@@ -2,15 +2,20 @@
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "coralogix_webhook Data Source - terraform-provider-coralogix"
 subcategory: ""
-description: |-
-  Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/.
+description: "Coralogix webhook. For more info please review - https://coralogix.com/docs/webhooks-api/ (documentation for the grpc endpoint will be provided soon)."
 ---
 
 # coralogix_webhook (Data Source)
 
-Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/.
+Coralogix webhook. For more info please review - https://coralogix.com/docs/webhooks-api/ (documentation for the grpc endpoint will be provided soon).
 
+## Example Usage
 
+```hcl
+data "coralogix_webhook" "imported_webhook" {
+  id = coralogix_webhook.slack_webhook.id
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/img.png b/docs/img.png
diff --git a/docs/index.md b/docs/index.md
@@ -35,7 +35,8 @@ resource "coralogix_rules_group" "my_first_rules_group" {
 <!-- schema generated by tfplugindocs -->
 
 ## Authentication
-
+For authentication, the Coralogix provider uses an api-key.
+![img.png](img.png)
 The api-key and the desired environment for using the Coralogix provider can be set in two ways:
 
 1. Explicitly:

diff --git a/docs/resources/webhook.md b/docs/resources/webhook.md
@@ -2,14 +2,24 @@
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "coralogix_webhook Resource - terraform-provider-coralogix"
 subcategory: ""
-description: "Webhook defines integration. More info - https://coralogix.com/integrations/ (Alerting section)."
+description: "Webhook defines integration. More info - https://coralogix.com/docs/webhooks-api/ (documentation for the grpc endpoint will be provided soon)."
 ---
 
 # coralogix_webhook (Resource)
 
-Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/.
+Coralogix webhook. For more info please review - https://coralogix.com/docs/webhooks-api/ (documentation for the grpc endpoint will be provided soon).
 
+## Example Usage
 
+```hcl
+resource "coralogix_webhook" "slack_webhook" {
+  name = "slack-webhook"
+  slack = {
+    notify_about = ["flow_anomalies"]
+    url = "https://join.slack.com/example"
+  }
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/examples/webhook/main.tf b/examples/webhook/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     coralogix = {
-      version = "~> 1.8"
+      version = "~> 1.9"
       source  = "coralogix/coralogix"
     }
   }
@@ -20,6 +20,10 @@ resource "coralogix_webhook" "slack_webhook" {
   }
 }
 
+data "coralogix_webhook" "imported_webhook" {
+  id = coralogix_webhook.slack_webhook.id
+}
+
 resource "coralogix_webhook" "custom_webhook" {
   name = "custom-webhook"
   custom = {
@@ -42,7 +46,7 @@ resource "coralogix_webhook" "email_group_webhook" {
     emails = ["user@example.com"]
   }
 }
-#
+
 resource "coralogix_webhook" "microsoft_teams_webhook" {
   name = "microsoft-teams-webhook"
   microsoft_teams ={