Skip to content

Commit d47ac01

Browse files
robfusionrobfusion
committed
Documentation updates for APIs related to webhook changes.
1 parent b0a0929 commit d47ac01

12 files changed

+41
-31
lines changed

‎site/docs/src/json/applications/post-request.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,5 @@
131131
"xmlSignatureC14nMethod": "exclusive_with_comments",
132132
"xmlSignatureLocation": "Assertion"
133133
}
134-
},
135-
"webhookIds": [
136-
"00000000-0000-0000-0000-000000000042"
137-
]
134+
}
138135
}

‎site/docs/src/json/applications/put-request.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,5 @@
8585
"numberOfDaysToRetain": 30
8686
}
8787
}
88-
},
89-
"webhookIds": [
90-
"00000000-0000-0000-0000-000000000042"
91-
]
88+
}
9289
}

‎site/docs/src/json/tenants/request.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"security": "TLS",
6060
"setPasswordEmailTemplateId": "a9aba13e-0125-4fd7-a2b1-aaa146b02423",
6161
"twoFactorMethodAddEmailTemplateId": "7c3045c7-97d8-47f8-8725-61b93deacf5d",
62-
"twoFactorMethodRemoveEmailTemplateId": "8c3045c7-97d8-47f8-8725-61b93deacf5d"
62+
"twoFactorMethodRemoveEmailTemplateId": "8c3045c7-97d8-47f8-8725-61b93deacf5d",
6363
"unverified": {
6464
"allowEmailChangeWhenGated": false,
6565
"behavior": "Allow"
@@ -345,6 +345,9 @@
345345
"numberOfDigits": 5,
346346
"separator": "#"
347347
}
348-
}
348+
},
349+
"webhookIds": [
350+
"00000000-0000-0000-0000-000000000042"
351+
]
349352
}
350353
}

‎site/docs/src/json/webhooks/request.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
{
22
"webhook": {
3-
"applicationIds": [
4-
"00000000-0000-0000-0000-000000000003",
5-
"00000000-0000-0000-0000-000000000004"
6-
],
73
"connectTimeout": 1000,
84
"data": { "updatedBy" : "richard" },
95
"description": "The standard game Webhook",
@@ -20,6 +16,10 @@
2016
"httpAuthenticationUsername": "username",
2117
"readTimeout": 2000,
2218
"sslCertificate": "-----BEGIN CERTIFICATE-----\nMIIDUjCCArugAwIBAgIJANZCTNN98L9ZMA0GCSqGSIb3DQEBBQUAMHoxCzAJBgNV\nBAYTAlVTMQswCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVyMQ8wDQYDVQQKEwZz\nZXRoLXMxCjAIBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAwHgYJKoZIhvcNAQkB\nFhFzamZkZkBsc2tkamZjLmNvbTAeFw0xNDA0MDkyMTA2MDdaFw0xNDA1MDkyMTA2\nMDdaMHoxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVy\nMQ8wDQYDVQQKEwZzZXRoLXMxCjAIBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAw\nHgYJKoZIhvcNAQkBFhFzamZkZkBsc2tkamZjLmNvbTCBnzANBgkqhkiG9w0BAQEF\nAAOBjQAwgYkCgYEAxnQBqyuYvjUE4aFQ6vVZU5RqHmy3KiTg2NcxELIlZztUTK3a\nVFbJoBB4ixHXCCYslujthILyBjgT3F+IhSpPAcrlu8O5LVPaPCysh/SNrGNwH4lq\neiW9Z5WAhRO/nG7NZNa0USPHAei6b9Sv9PxuKCY+GJfAIwlO4/bltIH06/kCAwEA\nAaOB3zCB3DAdBgNVHQ4EFgQUU4SqJEFm1zW+CcLxmLlARrqtMN0wgawGA1UdIwSB\npDCBoYAUU4SqJEFm1zW+CcLxmLlARrqtMN2hfqR8MHoxCzAJBgNVBAYTAlVTMQsw\nCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVyMQ8wDQYDVQQKEwZzZXRoLXMxCjAI\nBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAwHgYJKoZIhvcNAQkBFhFzamZkZkBs\nc2tkamZjLmNvbYIJANZCTNN98L9ZMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEF\nBQADgYEAY/cJsi3w6R4hF4PzAXLhGOg1tzTDYvol3w024WoehJur+qM0AY6UqtoJ\nneCq9af32IKbbOKkoaok+t1+/tylQVF/0FXMTKepxaMbG22vr4TmN3idPUYYbPfW\n5GkF7Hh96BjerrtiUPGuBZL50HoLZ5aR5oZUMAu7TXhOFp+vZp8=\n-----END CERTIFICATE-----",
19+
"tenantIds": [
20+
"32306536-3036-6431-3865-646430303332",
21+
"30663132-6464-6665-3032-326466613934"
22+
],
2323
"url": "http://mygameserver.local:7001/fusionauth-webhook"
2424
}
2525
}

‎site/docs/src/json/webhooks/response.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
{
22
"webhook": {
3-
"applicationIds": [
4-
"00000000-0000-0000-0000-000000000003",
5-
"00000000-0000-0000-0000-000000000004"
6-
],
73
"connectTimeout": 1000,
84
"data": { "updatedBy" : "richard" },
95
"description": "The standard game Webhook",
@@ -23,6 +19,10 @@
2319
"lastUpdateInstant": 1595361143101,
2420
"readTimeout": 2000,
2521
"sslCertificate": "-----BEGIN CERTIFICATE-----\nMIIDUjCCArugAwIBAgIJANZCTNN98L9ZMA0GCSqGSIb3DQEBBQUAMHoxCzAJBgNV\nBAYTAlVTMQswCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVyMQ8wDQYDVQQKEwZz\nZXRoLXMxCjAIBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAwHgYJKoZIhvcNAQkB\nFhFzamZkZkBsc2tkamZjLmNvbTAeFw0xNDA0MDkyMTA2MDdaFw0xNDA1MDkyMTA2\nMDdaMHoxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVy\nMQ8wDQYDVQQKEwZzZXRoLXMxCjAIBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAw\nHgYJKoZIhvcNAQkBFhFzamZkZkBsc2tkamZjLmNvbTCBnzANBgkqhkiG9w0BAQEF\nAAOBjQAwgYkCgYEAxnQBqyuYvjUE4aFQ6vVZU5RqHmy3KiTg2NcxELIlZztUTK3a\nVFbJoBB4ixHXCCYslujthILyBjgT3F+IhSpPAcrlu8O5LVPaPCysh/SNrGNwH4lq\neiW9Z5WAhRO/nG7NZNa0USPHAei6b9Sv9PxuKCY+GJfAIwlO4/bltIH06/kCAwEA\nAaOB3zCB3DAdBgNVHQ4EFgQUU4SqJEFm1zW+CcLxmLlARrqtMN0wgawGA1UdIwSB\npDCBoYAUU4SqJEFm1zW+CcLxmLlARrqtMN2hfqR8MHoxCzAJBgNVBAYTAlVTMQsw\nCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVyMQ8wDQYDVQQKEwZzZXRoLXMxCjAI\nBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAwHgYJKoZIhvcNAQkBFhFzamZkZkBs\nc2tkamZjLmNvbYIJANZCTNN98L9ZMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEF\nBQADgYEAY/cJsi3w6R4hF4PzAXLhGOg1tzTDYvol3w024WoehJur+qM0AY6UqtoJ\nneCq9af32IKbbOKkoaok+t1+/tylQVF/0FXMTKepxaMbG22vr4TmN3idPUYYbPfW\n5GkF7Hh96BjerrtiUPGuBZL50HoLZ5aR5oZUMAu7TXhOFp+vZp8=\n-----END CERTIFICATE-----",
22+
"tenantIds": [
23+
"32306536-3036-6431-3865-646430303332",
24+
"30663132-6464-6665-3032-326466613934"
25+
],
2626
"url": "http://mygameserver.local:7001/fusionauth-webhook"
2727
}
2828
}

‎site/docs/src/json/webhooks/responses.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
{
22
"webhooks": [
33
{
4-
"applicationIds": [
5-
"00000000-0000-0000-0000-000000000003",
6-
"00000000-0000-0000-0000-000000000004"
7-
],
84
"connectTimeout": 1000,
95
"data": { "updatedBy" : "richard" },
106
"description": "The standard game Webhook",
@@ -24,6 +20,10 @@
2420
"lastUpdateInstant": 1595361143101,
2521
"readTimeout": 2000,
2622
"sslCertificate": "-----BEGIN CERTIFICATE-----\nMIIDUjCCArugAwIBAgIJANZCTNN98L9ZMA0GCSqGSIb3DQEBBQUAMHoxCzAJBgNV\nBAYTAlVTMQswCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVyMQ8wDQYDVQQKEwZz\nZXRoLXMxCjAIBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAwHgYJKoZIhvcNAQkB\nFhFzamZkZkBsc2tkamZjLmNvbTAeFw0xNDA0MDkyMTA2MDdaFw0xNDA1MDkyMTA2\nMDdaMHoxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVy\nMQ8wDQYDVQQKEwZzZXRoLXMxCjAIBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAw\nHgYJKoZIhvcNAQkBFhFzamZkZkBsc2tkamZjLmNvbTCBnzANBgkqhkiG9w0BAQEF\nAAOBjQAwgYkCgYEAxnQBqyuYvjUE4aFQ6vVZU5RqHmy3KiTg2NcxELIlZztUTK3a\nVFbJoBB4ixHXCCYslujthILyBjgT3F+IhSpPAcrlu8O5LVPaPCysh/SNrGNwH4lq\neiW9Z5WAhRO/nG7NZNa0USPHAei6b9Sv9PxuKCY+GJfAIwlO4/bltIH06/kCAwEA\nAaOB3zCB3DAdBgNVHQ4EFgQUU4SqJEFm1zW+CcLxmLlARrqtMN0wgawGA1UdIwSB\npDCBoYAUU4SqJEFm1zW+CcLxmLlARrqtMN2hfqR8MHoxCzAJBgNVBAYTAlVTMQsw\nCQYDVQQIEwJDTzEPMA0GA1UEBxMGZGVudmVyMQ8wDQYDVQQKEwZzZXRoLXMxCjAI\nBgNVBAsTAXMxDjAMBgNVBAMTBWludmVyMSAwHgYJKoZIhvcNAQkBFhFzamZkZkBs\nc2tkamZjLmNvbYIJANZCTNN98L9ZMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEF\nBQADgYEAY/cJsi3w6R4hF4PzAXLhGOg1tzTDYvol3w024WoehJur+qM0AY6UqtoJ\nneCq9af32IKbbOKkoaok+t1+/tylQVF/0FXMTKepxaMbG22vr4TmN3idPUYYbPfW\n5GkF7Hh96BjerrtiUPGuBZL50HoLZ5aR5oZUMAu7TXhOFp+vZp8=\n-----END CERTIFICATE-----",
23+
"tenantIds": [
24+
"32306536-3036-6431-3865-646430303332",
25+
"30663132-6464-6665-3032-326466613934"
26+
],
2727
"url": "http://mygameserver.local:7001/fusionauth-webhook"
2828
}
2929
]

‎site/docs/v1/tech/apis/_application-request-body.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -478,8 +478,10 @@ The Id of the Email Template that is used to send the Registration Verification
478478
[field]#application.verifyRegistration# [type]#[Boolean]# [optional]#Optional# [default]#Defaults to `false`#::
479479
Whether or not registrations to this Application may be verified. When this is set to `true` the `verificationEmailTemplateId` parameter is also required.
480480

481-
[field]#webhookIds# [type]#[Array<UUID>]# [optional]#Optional#::
481+
[field]#webhookIds# [type]#[Array<UUID>]# [optional]#Optional# [deprecated]#Deprecated#::
482482
An array of Webhook Ids. For Webhooks that are not already configured for All Applications, specifying an Id on this request will indicate the associated Webhook should handle events for this application.
483+
+
484+
[deprecated]#Removed in version 1.37.0# In version 1.37.0 and beyond, Webhooks configuration can be managed in the `link:/docs/v1/tech/apis/tenants[Tenant API]`.
483485

484486
ifdef::includeRoles[]
485487
[source,json]

‎site/docs/v1/tech/apis/_tenant-request-body.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -875,6 +875,9 @@ This strategy instructions FusionAuth when to append a unique suffix to the user
875875
* `Always` - Always append a unique suffix even when the requested username is not in use.
876876
* `OnCollision` - Only append a unique suffix when the requested username is in use.
877877

878+
[field]#webhookIds# [type]#[Array<UUID>]# [optional]#Optional# [since]#Available since 1.37.0#::
879+
An array of Webhook Ids. For Webhooks that are not already configured for All Tenants, specifying an Id on this request will indicate the associated Webhook should handle events for this tenant.
880+
878881
[source,json]
879882
.Example Request JSON
880883
----

‎site/docs/v1/tech/apis/_webhook-request-body.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
==== Request Body
22

33
[.api]
4-
[field]#webhook.applicationIds# [type]#[Array<UUID>]# [optional]#Optional#::
4+
[field]#webhook.applicationIds# [type]#[Array<UUID>]# [optional]#Optional# [deprecated]#Deprecated#::
55
The Ids of the Applications that this Webhook should be associated with. If no Ids are specified and the [field]#global# field is `false`, this Webhook will not be used. Typically [field]#global# should be set to `true`.
6+
+
7+
[deprecated]#Removed in version 1.37.0# In version 1.37.0 and beyond, Webhooks are optionally associated with Tenants instead of Applications. See new field [field]#tenantIds#.
68

79
[field]#webhook.connectTimeout# [type]#[Integer]# [required]#Required#::
810
The connection timeout in milliseconds used when FusionAuth sends events to the Webhook.
@@ -46,6 +48,9 @@ The read timeout in milliseconds used when FusionAuth sends events to the Webhoo
4648
[field]#webhook.sslCertificate# [type]#[String]# [optional]#Optional#::
4749
An SSL certificate in PEM format that is used to establish the SSL (TLS specifically) connection to the Webhook.
4850

51+
[field]#webhook.tenantIds# [type]#[Array<UUID>]# [optional]#Optional# [since]#Available since 1.37.0#::
52+
The Ids of the Tenants that this Webhook should be associated with. If no Ids are specified and the [field]#global# field is `false`, this Webhook will not be used.
53+
4954
[field]#webhook.url# [type]#[String]# [required]#Required#::
5055
The fully qualified URL of the Webhook's endpoint that will accept the event requests from FusionAuth.
5156

‎site/docs/v1/tech/apis/_webhook-response-body-base.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[.api]
2-
[field]#{base_field_name}.applicationIds# [type]#[Array<UUID>]#::
3-
The Ids of the Applications that this Webhook should be associated with. If no Ids are specified and the `global` field is false, this Webhook will not be used.
2+
[field]#{base_field_name}.applicationIds# [type]#[Array<UUID>]# [optional]#Optional# [deprecated]#Deprecated#::
3+
The Ids of the Applications that this Webhook is associated with. If no Ids are returned and the [field]#global# field is `false`, this Webhook is not used. Typically [field]#global# should be set to `true`.
4+
+
5+
[deprecated]#Removed in version 1.37.0# In version 1.37.0 and beyond, Webhooks are optionally associated with Tenants instead of Applications. See new field [field]#tenantIds#.
46

57
[field]#{base_field_name}.connectTimeout# [type]#[Integer]#::
68
The connection timeout in milliseconds used when FusionAuth sends events to the Webhook.
@@ -53,6 +55,9 @@ The read timeout in milliseconds used when FusionAuth sends events to the Webhoo
5355
[field]#{base_field_name}.sslCertificate# [type]#[String]#::
5456
An SSL certificate in PEM format that is used to establish the SSL (TLS specifically) connection to the Webhook.
5557

58+
[field]#webhook.tenantIds# [type]#[Array<UUID>]# [optional]#Optional# [since]#Available since 1.37.0#::
59+
The Ids of the Tenants that this Webhook is associated with. If no Ids are returned and the [field]#global# field is `false`, this Webhook is not used.
60+
5661
[field]#{base_field_name}.url# [type]#[String]#::
5762
The fully qualified URL of the Webhook's endpoint that will accept the event requests from FusionAuth.
5863

‎site/docs/v1/tech/events-webhooks/_application-webhooks-warning.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
A few events can be generated for one or more specified applications, or for all applications within a tenant.
2-
31
[WARNING]
42
====
5-
The ability to limit the generation of an event for only certain applications is legacy functionality and will be modified in the future. If you want to get events for certain applications, send events for a tenant. Filter on the `applicationId` when consuming the event and discard events from any applications not of interest.
3+
This documentation is for versions earlier than 1.37.0. Application scoped events are not supported on versions later than 1.37.0. If you are on a version earlier than 1.37.0 and you want to get events for certain applications, the preferred method is to send events for a tenant. Filter on the `applicationId` when consuming the event and discard events from any applications not of interest.
64
75
**Please don't use application scoped webhook functionality.**
86
====
97

10-
These events can be application scoped:
8+
Prior to version 1.37.0 these events can be application scoped:
119

1210
* `jwt.public-key.update`
1311
* `jwt.refresh-token.revoke`

‎site/docs/v1/tech/events-webhooks/_tenant-or-application-scoped-event.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
This is a tenant or application scoped event. It can be sent to all applications in a tenant or to one or more specified applications. It will also be sent to all tenants that are listening for this event. A [field]#tenantId# will be present in the payload to allow for filtering.
22

3-
The ability to limit the generation of an event for only certain applications is legacy functionality and may be modified in the future. You almost certainly want to enable this event at the tenant level and optionally filter on the [field]#applicationId# when consuming the event.
3+
The ability to limit the generation of an event for only certain applications is legacy functionality and is removed as of version 1.37.0. You almost certainly want to enable this event at the tenant level and optionally filter on the [field]#applicationId# when consuming the event.

0 commit comments

Comments
 (0)