Edit Hooks Using the Command-Line InterfaceBeta

The Auth0 Command-Line Interface (CLI) allows you to edit existing Hooks associated with specific extensibility points within the Auth0 platform.

Prerequisite: Set up the Webtask CLI

Before proceeding, you'll need to set up the Webtask CLI. You can find instructions for installing and configuring the Webtask CLI in the Dashboard > Webtask page.

The wt-cli package also includes the auth0 binary, allowing you to use the Auth0 CLI.

Install Webtasks Instructions

Please note that all of the examples on this page use auth0-profile as the name of the profile. This is the same profile name used when installing wt-cli and can be obtained from Step 2 of the instructions set located on Auth0 Management Dashboard's Webtask page.

Tenants created after July 16, 2018 will not have access to the underlying Webtask Sandbox via the Webtask CLI. Please contact Auth0 to request access.

Edit the code of the Hook using the Webtask Editor. The following command will open up the code for the Hook in the Webtask Editor window:

auth0 edit my-extension-1

Webtask Editor

If the CLI cannot open the Editor window automatically, copy and paste the provided link into a web browser.

Please see the Webtask docs for detailed information on using the Webtask Editor.

Test Hooks

The Webtask Editor allows you to test the Hook using the Runner. By default, the Runner is hidden until you choose to display it by clicking its icon in the top left of the Editor.

The Runner allows you to simulate an Auth0 call to the Hook and provides the basic parameters needed to complete the call. Edit the provided schema as necessary.

When you're ready, click Run to proceed. You will be presented with the results of the call.

If you run multiple tests, the Runner keeps track of the calls you've made in its History section. For each result, See specific details about the call by clicking > to the right of the call result.

Test Runner Schema

If you created the Hook early on during the beta testing period, the Webtask Editor/Test Runner window might not populate with the schema required to successfully use the Test Runner. If that is the case, you'll need to save the Hook's code, delete the Hook, and create a new Hook using the existing code.

Manipulate secrets

If you provisioned a secret to the Hook during creation, manipulate the secret by clicking on the wrench at the top left of the Webtask Editor window and selecting Secrets from the dropdown menu.

Webtask Editor Secrets pane

To the right, you will see a Secrets window where you can add key/value pairs. These pairs can then be accessed in the code in the context.webtask.secrets object (e.g., context.webtask.secrets.SECRET_NAME).