Update Hooks

The End of Life (EOL) date of Rules and Hooks will be November 18, 2026, and they are no longer available to new tenants created as of October 16, 2023. Existing tenants with active Hooks will retain Hooks product access through end of life.

We highly recommend that you use Actions to extend Auth0. With Actions, you have access to rich type information, inline documentation, and public npm packages, and can connect external integrations that enhance your overall extensibility experience. To learn more about what Actions offer, read Understand How Auth0 Actions Work.

To help with your migration, we offer guides that will help you migrate from Rules to Actions and migrate from Hooks to Actions. We also have a dedicated Move to Actions page that highlights feature comparisons, an Actions demo, and other resources to help you on your migration journey.

To read more about the Rules and Hooks deprecation, read our blog post: Preparing for Rules and Hooks End of Life.

Because we plan to remove Rules and Hooks functions in 2026, you should create new Rules or Hooks only in your Development environment and only to test migration to Actions.

To learn how to migrate your Rules to Actions, read Migrate from Rules to Actions. To learn how to migrate your Hooks to Actions, read Migrate from Hooks to Actions.

You can update Hooks using the Dashboard or Management API.

You can also import and export hooks using the Deploy Command-Line Interface (CLI) tool.

Optionally, you can add secrets (such as Twilio Keys or database connection strings) to hooks.

Rename hooks using the Dashboard

1. Go to Auth0 Dashboard > Auth Pipeline > Hooks and click the gear icon next to the hook you want to rename.

2. Click Rename.

3. Type a new name for the Hook and click Rename.

   

Update hook scripts using the Dashboard

1. Go to Auth0 Dashboard > Auth Pipeline > Hooks and click the pencil icon next to the hook you want to update.

   

2. Update the hook using the Hook Editor and click the disk icon to save.

   

Update hooks using the Management API

Make a PATCH call to the Update a Hook endpoint. Be sure to replace HOOK_ID and MGMT_API_ACCESS_TOKEN placeholder values with your Hook ID and Management API Access Token, respectively.

cURL

curl --request PATCH \
  --url 'https://{yourDomain}/api/v2/hooks/HOOK_ID' \
  --header 'authorization: Bearer MGMT_API_ACCESS_TOKEN' \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --data '{ "name": "HOOK_NAME", "script": "HOOK_SCRIPT", "enabled": "true" }'

Value	Description
HOOK_ID	ID of the Hook to update.
MGMT_API_ACCESS_TOKEN	Access Tokens for the Management API with the scope update:hooks. To learn more, read Management API Access Tokens.
HOOK_NAME	Name of the Hook to create.
HOOK_SCRIPT	Script that contains the code for the Hook. Should match what you would enter if you were creating a new hook using the Dashboard.

The enabled property represents whether the rule is enabled (true) or disabled (false).

Handle rate limits when calling APIs from within Hooks

If you call Auth0 APIs from within a Hook’s script, you will need to handle rate limits. To do so, check the X-RateLimit-Remaining header and act appropriately when the number returned nears 0.

Additionally, add logic to handle cases in which you exceed the provided rate limits and receive the 429 HTTP Status Code (Too Many Requests). In this case, if a re-try is needed, it is best to allow for a back-off to avoid going into an infinite retry loop.