Skip to main content
Swagger
All documentation pages

Test the Webhook

Use Send Test Request to check that your webhook works. Portal sends a signed request to your saved webhook URL, using your saved signing secret and your own email address. You can send a test whether or not Automatic API Authentication is on, but you must apply a URL and a secret first. If you have unapplied edits, Send Test Request is unavailable. You can send one test about every 10 seconds.

To test your webhook:

  1. Click Send Test Request in the Automatic API Authentication tab.
  2. Read the result that Portal displays.

The test body adds "test": true. Verify the signature and respond as you would for a real login. Portal discards the returned token and does not store or display it.

The following example shows a test request body:

{"email":"admin@example.com","test":true}
Result Description
Success The webhook returned a 2xx response with a JSON object that contains a token.
URL not allowed The URL doesn’t meet the rules in Webhook URL Requirements.
Unreachable Portal can’t connect to the host.
Timeout The webhook didn’t respond within three seconds.
Redirect The webhook returned a 3xx response.
Rejected The webhook returned 401 or 403. Check the signing secret and your signature check.
Non-JSON response The response isn’t a JSON object.
Missing token The response has no token value.
Other error The webhook returned a different error.

Was this page helpful?