Skip to content

Commit 8ca0441

Browse files
committed
Documentation updates for APIs related to webhook changes.
1 parent 523b130 commit 8ca0441

File tree

5 files changed

+29
-1
lines changed

5 files changed

+29
-1
lines changed
Loading
Loading
Loading

site/docs/v1/tech/core-concepts/tenants.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,10 @@ When enabled the user's password hash will be modified if it does not match the
434434
==== Webhooks
435435
image::core-concepts/tenant-configuration-webhooks-settings.png[Tenant Configuration - Webhooks,width=1200,role=shadowed]
436436

437-
===== Table Columns
437+
===== Webhooks
438+
Enable the webhooks you wish to receive events from this tenant. All webhooks will be shown, but if the webhook is a `global` webhook then you will not be able to unselect it here. That must be done in the link:/docs/v1/tech/events-webhooks#tenants[Webhook Settings]
439+
440+
===== Event Settings
438441

439442
include::docs/v1/tech/events-webhooks/_tenant-webhooks-table.adoc[]
440443

site/docs/v1/tech/events-webhooks/index.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Continue reading below to see how the events and webhooks are configured using t
3030

3131
* <<Tenant Settings>>
3232
* <<Add Webhook>>
33+
* <<Tenants>>
3334
* <<Test a Webhook>>
3435

3536
== Tenant Settings
@@ -131,6 +132,7 @@ The SSL certificate in PEM format to be used when connecting to the webhook. Whe
131132

132133

133134
=== Applications
135+
include::docs/v1/tech/events-webhooks/_application-webhooks-warning.adoc[]
134136

135137
image::webhook-settings-applications.png[Webhook Settings - All applications,width=1200,role=shadowed bottom-cropped top-cropped]
136138

@@ -154,6 +156,29 @@ Not all events are considered application specific and selecting an application
154156
+
155157
In most cases you will want to use the [field]#All applications# configuration.
156158

159+
=== Tenants
160+
Available since 1.37.0
161+
162+
image::webhook-settings-tenants.png[Webhook Settings - All applications,width=1200,role=shadowed bottom-cropped top-cropped]
163+
164+
image::webhook-settings-tenants-selection.png[Webhook Settings - Select Applications,width=1200,role=shadowed bottom-cropped top-cropped]
165+
166+
167+
==== Form Fields
168+
169+
[.api]
170+
All tenants::
171+
When this toggle is enabled, all events for all tenants will be sent to this webhook.
172+
173+
Tenants::
174+
When the [field]#All tenants# is disabled, this field will be exposed. Select the tenants for which you would like to receive events.
175+
+
176+
All events are considered tenant specific and selecting a tenant will limit you to only receiving tenant events. All events are tenant events except for the following instance events:
177+
+
178+
- `audit-log.create`
179+
- `event-log.create`
180+
- `kickstart.success`
181+
157182
=== Headers
158183

159184
image::webhook-settings-headers.png[Webhook Settings - HTTP Headers,width=1200,role=shadowed top-cropped]

0 commit comments

Comments
 (0)