Merge pull request #461 from snyk/chore/add-warning-for-webhooks-v1-page

added warning for webhooks v1 page

Author: mikeromard

docs/snyk-api/reference/webhooks-v1.md

@@ -4,6 +4,10 @@
 This document uses the v1 API. For more details, see the [v1 API](../v1-api.md).
 {% endhint %}
 
+{% hint style="warning" %}
+The Webhooks API is in beta. While the API is in beta, Snyk may change the API and the structure of webhook payloads at any time, without notice. During this beta, Webhooks are available only in the Snyk US-01, US-02, EU-01, and AU-01 regions.
+{% endhint %}
+
 {% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/webhooks" method="post" %}
 [v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
 {% endswagger %}

tools/api-docs-generator/config.yml

@@ -14,6 +14,11 @@ categoryContext:
 - name: projects-v1
   hint: |
     **Note:** For a list of Project types, see [Project type responses from the API](../snyk-api/api-endpoints-index-and-tips/project-type-responses-from-the-api).
+- name: webhooks-v1
+  hint: |
+    {% hint style="warning" %}
+    The Webhooks API is in beta. While the API is in beta, Snyk may change the API and the structure of webhook payloads at any time, without notice. During this beta, Webhooks are available only in the Snyk US-01, US-02, EU-01, and AU-01 regions.
+    {% endhint %}
 output:
     summaryPath: docs/SUMMARY.md
     apiReferencePath: docs/snyk-api/reference