First pass at explaining provider.webhook_url behaviour

buildkite · Aug 9, 2023 · 9ff5533 · 9ff5533
1 parent 846e384
commit 9ff5533
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/pages/apis/rest_api/builds.md b/pages/apis/rest_api/builds.md
@@ -171,6 +171,8 @@ Optional [query string parameters](/docs/api#query-string-parameters):
 
 Required scope: `read_builds`
 
+Note: `pipeline.provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
+
 Success response: `200 OK`
 
 ## Get a build
@@ -299,6 +301,8 @@ Optional [query string parameters](/docs/api#query-string-parameters):
 
 Required scope: `read_builds`
 
+Note: `pipeline.provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
+
 Success response: `200 OK`
 
 ## Create a build
@@ -452,6 +456,8 @@ Optional [request body properties](/docs/api#request-body-properties):
 
 Required scope: `write_builds`
 
+Note: `pipeline.provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
+
 Success response: `201 Created`
 
 Error responses:
@@ -575,6 +581,8 @@ curl -X PUT "https://api.buildkite.com/v2/organizations/{org.slug}/pipelines/{pi
 
 Required scope: `write_builds`
 
+Note: `pipeline.provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
+
 Success response: `200 OK`
 
 Error responses:
@@ -697,6 +705,8 @@ curl -X PUT "https://api.buildkite.com/v2/organizations/{org.slug}/pipelines/{pi
 
 Required scope: `write_builds`
 
+Note: `pipeline.provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
+
 Success response: `200 OK`
 
 ## Timestamp attributes

diff --git a/pages/apis/rest_api/pipelines.md b/pages/apis/rest_api/pipelines.md
@@ -76,6 +76,8 @@ curl "https://api.buildkite.com/v2/organizations/{org.slug}/pipelines"
 
 Required scope: `read_pipelines`
 
+Note: `provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
+
 Success response: `200 OK`
 
 ## Get a pipeline
@@ -150,8 +152,9 @@ curl "https://api.buildkite.com/v2/organizations/{org.slug}/pipelines/{slug}"
 
 Required scope: `read_pipelines`
 
-Success response: `200 OK`
+Note: `provider.webhook_url` value is only returned if the user has edit permissions for the pipeline.
 
+Success response: `200 OK`
 
 ## Create a YAML pipeline