OAuth FAQs
Here you will find answers to commonly encountered questions.If you are having trouble and cannot find a suitable answer, please reach out to support.
How do I listen to webhook events?
To listen to webhook events:- Register for an app in the Developer Marketplace.
- Go to the app settings and update the webhook URL (where you want to listen for events).
- Under the settings, add the scope needed for the webhook event under the Scopes section.
- Ask the location/agency admin to go to the app page in the Marketplace and click Add App.
- Select the location. You will be redirected to the redirect URI with the authorization code.
- Use the authorization code to get the access token.
- You will start receiving webhook events for the location.
How long are the access tokens valid?
Access tokens are valid for one day. After expiry, use the refresh token to obtain a new access token, which will also be valid for another day.How long are the refresh tokens valid?
Refresh tokens are valid for one year unless they are used. When used, the new refresh token is also valid for one year.How should we handle token expiry?
- Make a request to any API using the
accessToken. - If the response indicates the token is expired, call the refresh token API and save the new
accessTokenandrefreshTokenin your database. - Retry the original request with the new
accessToken.
What are the current rate limits for API 2.0?
The HoopAI Platform enforces the following rate limits on public V2 APIs:- Burst limit: 100 API requests per 10 seconds per Marketplace app per resource (Location or Company).
- Daily limit: 200,000 API requests per day per Marketplace app per resource (Location or Company).
| Header | Description |
|---|---|
X-RateLimit-Limit-Daily | Your daily limit |
X-RateLimit-Daily-Remaining | Remaining requests for the day |
X-RateLimit-Interval-Milliseconds | Time interval for burst requests |
X-RateLimit-Max | Maximum request limit in the specified time interval |
X-RateLimit-Remaining | Remaining requests in the current time interval |
.png?fit=max&auto=format&n=EQK5eX9kTD8NzWwA&q=85&s=878008bf159fcc4964d0c0d508b6e400)