If you don’t see your preferred webhook provider, you can request support for it.
- Develop and test Okta webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Okta in real time via the inspection UI and API.
- Modify and replay Okta webhook requests with a single click instead of reproducing events manually in your Okta account.
- Secure your app with Okta webhook validation provided by ngrok. Invalid requests are blocked by ngrok before reaching your app.
What you’ll need
- An ngrok account and your authtoken.
- The ngrok agent installed.
- Node.js installed (for the sample app, or use your own app).
- An Okta account.
1. Start your app
For this tutorial, you can use the sample Node.js app on GitHub. To install the sample, run the following in a terminal:http://localhost:3000.
The app logs request headers and body in the terminal and shows a message in the browser.
2. Expose your app with ngrok
Once your app is running locally, you’re ready to put it online securely using ngrok.- Copy your ngrok authtoken from the dashboard.
-
Start ngrok:
- Copy the URL ngrok displays. Your app is now exposed at that URL for use with Okta.
3. Configure Okta to send webhooks
Follow Okta’s documentation for creating an event hook, and set the following:- Name: a name for the event hook (for example,
My Webhook). - URL: your ngrok URL (for example,
https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). - Events: choose which events trigger the hook (for this example, User sign in attempt).
Run webhooks with Okta and ngrok
Okta sends different request body contents depending on the event. You can send a test delivery from the event hook, or trigger a real event by signing out of the Okta console and signing in again. Confirm your localhost app receives the event and logs both headers and body in the terminal.Inspecting requests
ngrok’s Traffic Inspector captures all requests made through your ngrok endpoint to your localhost app. Select any request to view detailed information about both the request and response.To avoid exposing secrets, accounts only collect traffic metadata by default.
You must enable full capture in the Traffic Inspector section of your account settings to capture complete request and response data.
- Validate webhook payloads and response data
- Debug request headers, methods, and status codes
- Troubleshoot integration issues without adding logging to your app
Replaying requests
Test your webhook handling code without triggering new events from your service using the Traffic Inspector’s replay feature:- Send a test webhook from your service to generate traffic in your Traffic Inspector.
- Select the request you want to replay in the traffic inspector.
-
Choose your replay option:
- Click Replay to send the exact same request again
- Select Replay with modifications to edit the request before sending
- (Optional) Modify the request: Edit any part of the original request, such as changing field values in the request body.
- Send the request by clicking Replay.