Adal quickstart guide
Quickly get started with Adal by following our step-by-step guide to set up your first webhook receiver and start receiving events in no time.
# Create an account
Before you can receive and inspect webhooks, you need to create an Adal account.
Adal currently supports email-based registration only.
After registration, you must verify your email address before you can use the dashboard and connect the
CLI.
Open the registration page: Adal dashboard registration
After registration:
1. Check your inbox.
2. Open the email from Adal.
3. Click the verification link to activate your account.
Once the email is verified, you can sign in to the dashboard and continue with endpoint creation.
Expected result:
• Your account is activated.
• You can sign in to the dashboard.
• The dashboard becomes available for use.
# Create an endpoint
Endpoints are public webhook URLs managed by Adal.
Open the endpoints page: Endpoints dashboard
Then click Create endpoint in the top-right corner. You will be redirected to create endpoint page
Configure the endpoint:
• Choose a region.
• Enter a name.
• Leave the remaining settings as default for now.
Then click Save endpoint
After creation, Adal will display:
• Public Ingest URL.
• CLI Token.
Important
The CLI token is shown only once immediately after endpoint creation.
Store it securely before leaving the page.
Expected result:
• The endpoint is created.
• You receive a public webhook URL.
• You receive a CLI token.
# Create a destination
Destinations are the URLs where Adal forwards incoming webhook requests.
Open the destinations page: Destinations dashboard
Then click Add destination in the top-right corner. You will be redirected to create destination page
Configure the destination:
• Select the region.
• Select the endpoint.
• Enter a destination name.
• Enter the target URL.
The destination URL can point to:
• A local development server.
• A private internal service.
• Or a public external API.
When finished, click Save destination
Expected result:
• The destination is attached to your endpoint.
• Adal is ready to forward incoming webhook requests to the specified URL.
# Run the CLI
The Adal CLI maintains a secure connection to your endpoint and receives incoming webhook requests in real time.
Download the CLI binary or build it from source on GitHub
Once connected, the CLI will begin receiving and forwarding webhook deliveries automatically.
Optional flags:
Displays the CLI version.
Controls log verbosity.
Available levels:
•
0
— minimal output.
•
1
— dasic delivery information.
•
2
— extended logs.
•
3
— detailed debug output.
Example:
Expected result:
• The CLI connects successfully.
• The endpoint status becomes connected.
• Incoming webhook deliveries start appearing in the terminal.
# Send a test webhook
Now you can test the full delivery flow.
Send an HTTP request to your Adal endpoint using CURL:
-H "Content-Type: application/json" \
-H "X-Test-Source: quickstart" \
-d '{"message":"Hello from Adal"}'
What happens next:
1. Adal receives the request.
2. The request is delivered to the connected CLI.
3. The CLI forwards the request to your configured
destination.
The forwarded request preserves:
• The original HTTP method.
• Headers.
• Body.
• And request metadata.
The request will be forwarded to the URL configured in the destination settings.
Expected result:
• The request appears in the CLI logs.
• The request is forwarded to the destination.
• The delivery is marked as successful in the dashboard.
# Inspect requests
All received requests are available in the Adal dashboard.
Open Requests dashboard
You should see the webhook request sent in the previous step.
Click Details to open the full request information page.
The request details page includes:
• Request headers.
• Request metadata.
• Delivery status.
• Destination delivery information.
You can also:
• Download the original request body.
• Preview the body directly in the browser for some
content types.
Expected result:
• The request is visible in the dashboard.
• Delivery information is available.
• The original request body can be inspected or downloaded.