Resources
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/webhooks/search-for-webhooks.md.

Search for Webhooks

Edit on GitHub
View Markdown
version

This API has been available since 1.45.0

This API is used to search for Webhooks and may be called using the GET or POST HTTP methods. Examples of each are provided below. The POST method is provided to allow for a richer request object without worrying about exceeding the maximum length of a URL. Calling this API with either the GET or POST HTTP method will provide the same search results given the same query parameters.

Request#

Global API Key Authentication
Search for Webhooks
GET/api/webhook/search?description={description}
OpenAPI Spec

Request Parameters#

description String optional

The case-insensitive string to search for in the Webhook description. This can contain wildcards using the asterisk character (*). If no wildcards are present, this parameter value will be interpreted as *value*.

numberOfResults Integer optional Defaults to 25

The number of results to return from the search.

orderBy String optional Defaults to name ASC

The field to order the search results as well as an order direction.

The possible values are:

  • description - the description of the Webhook
  • id - the unique Id of the Webhook
  • insertInstant - the instant when the Webhook was created
  • url - the Webhook URL

The order direction is optional. Possible values of the order direction are ASC or DESC. If omitted, the default sort order is ASC.

For example, to order the results by the insert instant in a descending order, use insertInstant DESC.

startRow Integer optional Defaults to 0

The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

For example, if the total search results are greater than the page size designated by numberOfResults, set this value to 25 to retrieve results 26-50, assuming the default page size.

tenantId UUID optional

Restricts the results to Webhooks associated with the given Tenant and all global Webhooks.

url String optional

The case-insensitive string to search for in the Webhook URL. This can contain wildcards using the asterisk character (*). If no wildcards are present, this parameter value will be interpreted as *value*.

Global API Key Authentication
Search for Webhooks
POST/api/webhook/search
OpenAPI Spec

When calling the API using a POST request you will send the search criteria in a JSON request body.

Request Body#

search.description String optional

The case-insensitive string to search for in the Webhook description. This can contain wildcards using the asterisk character (*). If no wildcards are present, this parameter value will be interpreted as *value*.

search.numberOfResults Integer optional Defaults to 25

The number of results to return from the search.

search.orderBy String optional Defaults to name ASC

The field to order the search results as well as an order direction.

The possible values are:

  • description - the description of the Webhook
  • id - the unique Id of the Webhook
  • insertInstant - the instant when the Webhook was created
  • url - the Webhook URL

The order direction is optional. Possible values of the order direction are ASC or DESC. If omitted, the default sort order is ASC.

For example, to order the results by the insert instant in a descending order, use insertInstant DESC.

search.startRow Integer optional Defaults to 0

The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

For example, if the total search results are greater than the page size designated by numberOfResults, set this value to 25 to retrieve results 26-50, assuming the default page size.

search.tenantId UUID optional

Restricts the results to Webhooks associated with the given Tenant and all global Webhooks.

search.url String optional

The case-insensitive string to search for in the Webhook URL. This can contain wildcards using the asterisk character (*). If no wildcards are present, this parameter value will be interpreted as *value*.

Example Response JSON

{
  "search": {
    "description": "game",
    "numberOfResults": 25,
    "orderBy": "insertInstant",
    "startRow": 0,
    "tenantId": "30663132-6464-6665-3032-326466613934"
  }
}

Response#

The response for this API contains the Webhooks matching the search criteria in paginated format and the total number of results matching the search criteria.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

webhooks[x].applicationIds Array<UUID> optional DEPRECATED

The Ids of the Applications that this Webhook is associated with. If no Ids are returned and the global field is false, this Webhook is not used. Typically global should be set to true.

Removed in 1.37.0

In version 1.37.0 and beyond, Webhooks are optionally associated with Tenants instead of Applications. See new field tenantIds.

webhooks[x].connectTimeout Integer

The connection timeout in milliseconds used when FusionAuth sends events to the Webhook.

webhooks[x].data Object Available since 1.15.0

An object that can hold any information about the Webhook that should be persisted.

webhooks[x].description String

A description of the Webhook. This is used for display purposes only.

webhooks[x].eventsEnabled Object

A mapping for the events that are enabled for this Webhook. The key of the Object property is the name of the event and the value is a boolean. It should look like this:

{
"user.create": true,
"user.delete": false
}

The possible event types are:

  • audit-log.create - When an audit log is created Available since 1.30.0
  • entity.create - When an entity is created Available since 1.69.0
  • entity.create.complete - When an entity create transaction has completed Available since 1.69.0
  • entity.delete - When an entity is deleted Available since 1.69.0
  • entity.delete.complete - When an entity delete transaction has completed Available since 1.69.0
  • entity.update - When an entity is updated Available since 1.69.0
  • entity.update.complete - When an entity update transaction has completed Available since 1.69.0
  • event-log.create - When an event log is created Available since 1.30.0
  • jwt.public-key.update - When a JWT signing Public / Private keypair may have been changed
  • jwt.refresh - When an access token is refreshed using a refresh token Available since 1.16.0
  • jwt.refresh-token.revoke - When a JWT Refresh Token is revoked
  • kickstart.success - When kickstart has successfully completed Available since 1.30.0
  • user.action - When a user action is triggered
  • user.bulk.create - When multiple users are created in bulk (i.e. during an import)
  • user.create - When a user is created
  • user.create.complete - When a user create transaction has completed Available since 1.30.0
  • user.deactivate - When a user is deactivated
  • user.delete - When a user is deleted
  • user.delete.complete - When a user delete transaction has completed Available since 1.30.0
  • user.email.update - When a user updates their email address Available since 1.30.0
  • user.email.verified - When a user verifies their email address Available since 1.8.0
  • user.identity-provider.link - When a link is created from a user to an Identity Provider Available since 1.36.0
  • user.identity-provider.unlink - When an existing Identity Provider link is removed from a User Available since 1.36.0
  • user.identity.verified - When a user's identity is verified Available since 1.59.0
  • user.loginId.duplicate.create - When a request to create a user with a login Id (email or username) which is already in use has been received Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.loginId.duplicate.update - When a request to update a user and change their login Id (email or username) to one that is already in use has been received Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.login.failed - When a user fails a login request Available since 1.6.0
  • user.login.new-device - When a user begins a login request with a new device Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.login.success - When a user completes a login request Available since 1.6.0
  • user.login.suspicious - When a user logs in and is considered to be a potential threat (requires an activated Enterprise license) Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.password.breach - When Reactor detects a user is using a potentially breached password (requires an activated license) Available since 1.15.0

    Note: To use , you'll need a paid plan.

  • user.password.reset.send - When a forgot password email has been sent to a user Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.password.reset.start - When the process to reset a user password has started Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.password.reset.success - When a user has successfully reset their password Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.password.update - When a user has updated their password Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.reactivate - When a user is reactivated
  • user.registration.create - When a user registration is created Available since 1.6.0
  • user.registration.create.complete - When a user registration create transaction has completed Available since 1.30.0
  • user.registration.delete - When a user registration is deleted Available since 1.6.0
  • user.registration.delete.complete - When a user registration delete transaction has completed Available since 1.30.0
  • user.registration.update - When a user registration is updated Available since 1.6.0
  • user.registration.update.complete - When a user registration update transaction has completed Available since 1.30.0
  • user.registration.verified - When a user completes registration verification Available since 1.8.0
  • user.two-factor.challenge - When a user is presented a two-factor challenge Available since 1.68.0

    Note: To use , you'll need an Enterprise plan.

  • user.two-factor.failed-attempt - When a user submits an incorrect answer to a two-factor challenge Available since 1.68.0

    Note: To use , you'll need an Enterprise plan.

  • user.two-factor.method.add - When a user has added a two-factor method Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.two-factor.method.remove - When a user has removed a two-factor method Available since 1.30.0

    Note: To use , you'll need an Enterprise plan.

  • user.two-factor.success - When a user submits a correct answer to a two-factor challenge Available since 1.68.0

    Note: To use , you'll need an Enterprise plan.

  • user.update - When a user is updated
  • user.update.complete - When a user update transaction has completed Available since 1.30.0
webhooks[x].global Boolean

Whether or not this Webhook is used for all Tenants or just for specific Tenants.

Before version 1.37.0

Whether or not this Webhook is used for all events or just for specific Applications.

webhooks[x].headers Map<String, String>

An object that contains headers that are sent as part of the HTTP request for the events.

webhooks[x].httpAuthenticationPassword String

The HTTP basic authentication password that is sent as part of the HTTP request for the events.

webhooks[x].httpAuthenticationUsername String

The HTTP basic authentication username that is sent as part of the HTTP request for the events.

webhooks[x].id UUID

The Id of the Webhook.

webhooks[x].insertInstant Long

The instant that the Webhook was added to the FusionAuth database.

webhooks[x].lastUpdateInstant Long

The instant that the Webhook was last updated in the FusionAuth database.

webhooks[x].readTimeout Integer

The read timeout in milliseconds used when FusionAuth sends events to the Webhook.

webhooks[x].signatureConfiguration.enabled Boolean Defaults to false

Whether or not webhook events are signed.

webhooks[x].signatureConfiguration.signingKeyId UUID optional

The Id of the key used to sign webhook events.

webhooks[x].sslCertificate String DEPRECATED

An SSL certificate in PEM format that is used to establish the SSL (TLS specifically) connection to the Webhook.

Deprecated since 1.48.0

In version 1.48.0 and beyond, the webhook SSL certificate can be managed via webhook.sslCertificateKeyId.

webhooks[x].sslCertificateKeyId UUID Available since 1.48.0

The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Webhook.

webhooks[x].tenantIds Array<UUID> optional Available since 1.37.0

The Ids of the Tenants that this Webhook is associated with. If no Ids are returned and the global field is false, this Webhook is not used.

webhooks[x].url String

The fully qualified URL of the Webhook's endpoint that will accept the event requests from FusionAuth.

Example Response JSON for all the Webhooks

{
  "webhooks": [
    {
      "connectTimeout": 1000,
      "data": {
        "updatedBy": "richard"
      },
      "description": "The standard game Webhook",
      "eventsEnabled": {
        "user.create": true,
        "user.delete": false
      },
      "global": false,
      "headers": {
        "Header 1": "value 1",
        "Header 2": "value 2"
      },
      "httpAuthenticationPassword": "password",
      "httpAuthenticationUsername": "username",
      "id": "00000000-0000-0000-0000-000000000042",
      "insertInstant": 1471786482322,
      "lastUpdateInstant": 1595361143101,
      "readTimeout": 2000,
      "signatureConfiguration": {
        "enabled": true,
        "signingKeyId": "401c9046-b274-403f-963d-adc5024c6ef0"
      },
      "sslCertificateKeyId": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
      "tenantIds": [
        "32306536-3036-6431-3865-646430303332",
        "30663132-6464-6665-3032-326466613934"
      ],
      "url": "http://mygameserver.local:7001/fusionauth-webhook"
    }
  ]
}