Skip to main content
Swagger
All documentation pages

FAQ

Here are answers to frequently asked questions about Swagger Portal. Don’t see what you’re looking for? Visit our Community forum.

Why do Try It Out requests go out without an Authorization header?

Portal didn’t call your webhook, or the call failed. Check the following:

  • Automatic API Authentication is turned on, and you applied your changes.
  • The member logged in after you turned on Automatic API Authentication.
  • Your webhook logs show the call and any errors.

Why does my webhook never receive a call?

Portal doesn’t call your webhook in these cases:

  • The user isn’t a member of the Swagger Studio organization that your portal belongs to.
  • Automatic API Authentication isn’t turned on, or you didn’t apply your changes.
  • You didn’t save a webhook URL or a signing secret.
  • The URL doesn’t meet the Webhook URL Requirements.
  • Your plan doesn’t include portal personalization.
  • The login had no portal token. This can happen with some external identity provider logins.

Why does my webhook receive calls, but Portal doesn’t use the token?

One of the following happened:

  • The webhook didn’t return a 2xx response with a JSON object that contains a token within three seconds.
  • Your API runs on a different origin than your webhook, and the origin isn’t in audience.

Why do requests to my API return 401 after they worked earlier?

The token expired before the session ended. Log out of Portal, and then log in again.

Why does the signature check fail?

The signature check fails in these cases:

  • Your webhook re-serialized the raw request body. Verify the signature against the raw body exactly as you received it.
  • The signing secret differs. For example, you regenerated the secret and didn’t apply it, or you applied it and didn’t deploy it to your webhook.
  • The clock on your server is more than five minutes off.

Why does Try It Out fail for an API that is available only on my VPN?

Portal sends Try It Out requests from its server, so it can’t reach APIs that are available only from the member’s network. Learn more in Try It Out Behavior.

Was this page helpful?