Overview
Adal CLI is a command-line application that delivers webhooks from Adal to services available only from your computer or private network. You do not need to expose your local server to the internet.
The CLI is designed for local development and testing webhook handlers. Direct HTTP is usually a better choice for a public HTTPS endpoint.
How Adal CLI works
The CLI establishes a secure outbound connection to Adal. An accepted webhook is passed to the connected CLI, which sends it to the Destination URL.
The method, path, query parameters, headers, and body are forwarded to the application, and its response is recorded in the delivery history.
Important: while the CLI is disconnected, the request waits for a connection subject to its retention period.
Installation
Download the archive for your operating system from the Adal CLI releases page , extract it, and add the executable to your PATH . You can also build the CLI from source .
Getting a token
- Open the Server in the Adal dashboard.
- Create a Destination of type Adal CLI.
- Enter a URL, for example http://127.0.0.1:3000 .
- Copy the token and store it securely.
The original token is shown only when it is created. Replace it if it is lost or exposed.
Running Adal CLI
Start your local application, then connect the CLI:
To display delivery details:
Command-line options
- --token <token> — token used to connect to Adal.
- --verbose <level> — log verbosity level from 0 to 3.
- --version — display the CLI version.
Levels: 0 shows minimal output, 1 shows delivery details, 2 enables extended logs, and 3 enables detailed debugging information.
Security
- Do not commit the token to a repository or expose it in logs or screenshots.
- Run Adal CLI only in a trusted environment.
- Use separate tokens for different environments.
- Replace an exposed token immediately.
- Verify the sender signature in your webhook handler.
Troubleshooting
The CLI cannot connect
Check the token, internet connection, proxy, and firewall. For diagnostics, use --verbose 2 or --verbose 3 .
The application does not receive requests
Make sure the application is running and that the Destination URL, port, path, and protocol are correct.
Requests remain pending
Make sure the CLI is connected with the token for the correct Destination, then check the delivery history.
Delivery fails
Inspect the application response and the CLI logs. A 4xx or 5xx response means the request reached the application, but the application returned an error.
Related pages
- Quickstart — create a Server and Destination and perform your first test delivery.
- Destinations — configure Adal CLI delivery, retries, and delivery history.
- Servers — accept webhooks, configure Server settings, and deliver pending requests.
- Security — protect connections, tokens, and data.