Skip to content

Commit 33151cc

Browse files
authored
Add documentation around webhooks_notifications for databricks_job (#1968)
* Add documentation around webhooks_notifications * Create job.md * Update job.md * Update job.md
1 parent e29e299 commit 33151cc

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/resources/job.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,17 @@ Each entry in `webhook_notification` block takes a list `webhook` blocks. The fi
128128
* `on_success` - (Optional) (List) list of notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified.
129129
* `on_failure` - (Optional) (List) list of notification IDs to call when the run fails. A maximum of 3 destinations can be specified.
130130

131+
Note that the `id` is not to be confused with the name of the alert destination. The `id` can be retrieved through the API or the URL of Databricks UI `https://<workspace host>/sql/destinations/<notification id>?o=<workspace id>`
132+
133+
Example
134+
```hcl
135+
webhook_notifications {
136+
on_failure {
137+
id = "fb99f3dc-a0a0-11ed-a8fc-0242ac120002"
138+
}
139+
}
140+
```
141+
131142
### webhook Configuration Block
132143

133144
* `id` - ID of the system notification that is notified when an event defined in `webhook_notifications` is triggered.

0 commit comments

Comments
 (0)