Documentation updates for APIs related to webhook changes #1546
Conversation
Documentation updates for APIs related to webhook changes.
Documentation updates for APIs related to webhook changes.
Documentation updates for APIs related to webhook changes.
Documentation updates for APIs related to webhook changes.
Documentation updates for APIs related to webhook changes.
| @@ -46,6 +48,9 @@ The read timeout in milliseconds used when FusionAuth sends events to the Webhoo | |||
| [field]#webhook.sslCertificate# [type]#[String]# [optional]#Optional#:: | |||
| An SSL certificate in PEM format that is used to establish the SSL (TLS specifically) connection to the Webhook. | |||
|
|
|||
| [field]#webhook.tenantIds# [type]#[Array<UUID>]# [optional]#Optional# [since]#Available since 1.37.0#:: | |||
There was a problem hiding this comment.
Should webhook request/response descriptions for tenantIds be updated to reference the applicationIds field to help people on older versions find the correct field?
There was a problem hiding this comment.
If you mean in the JSON example, then from what I can see, the JSON always represents current state and the file descriptions provide information about prior deprecated fields.
| ==== | ||
| This feature is removed as of version 1.37.0. | ||
| ==== | ||
|
|
||
| The Webhooks tab allows you to select one or more webhooks to be used for this Application. In this example screenshot either no webhooks have been configured, or no application specific webhooks are configured. |
There was a problem hiding this comment.
Should a version of this section be added to the Tenant core concepts page? I'm not sure whether there was additional webhook configuration added at the tenant level.
There was a problem hiding this comment.
In the upcoming PR
| @@ -41,6 +42,16 @@ If you have multiple tenants listening for the same event, they will all receive | |||
|
|
|||
| include::docs/v1/tech/events-webhooks/_application-webhooks-warning.adoc[] | |||
|
|
|||
| === Tenant Scoped Events | |||
|
|
|||
| As of version 1.37.0, all events can be tenant scoped except instance events: | |||
There was a problem hiding this comment.
In the admin UI we are calling these system events. We could use the same wording here, or explain what an instance event is.
--FusionAuth/fusionauth-issues#1812
Documentation updates for APIs related to webhook changes.