API and Integrations FAQs
Common questions about API keys, webhooks, and integrations.
Does Scalar have an API?
Yes. Scalar provides an API for server-to-server integrations. The API allows you to programmatically access and manage ideas, surveys, announcements, and customers.
How do I get an API key?
- Go to Settings > API (in the API & Integrations section)
- Click Generate key
- Copy and store the key securely
The full API key is only shown once when created. If you lose it, you'll need to generate a new one.
What does the API key format look like?
API keys have a prefix indicating the environment:
| Prefix | Environment |
|---|---|
scalar_live_ | Production |
scalar_test_ | Development/Test |
Are there rate limits?
Yes. API requests are rate-limited per hour. You can check your rate limit and current usage in the API settings page. If you exceed the limit, requests return an HTTP 429 error.
What authentication methods does the API support?
The API supports two authentication methods:
| Method | Format |
|---|---|
| Header (Recommended) | Authorization: Api-Key <key> or X-API-Key: <key> |
| HTTP Basic | Username = API key, Password = blank |
What are webhooks?
Webhooks let you receive real-time HTTP notifications when events occur in Scalar. When an event happens, Scalar sends an HTTP POST request to your configured URL.
What webhook events are available?
| Event | Description |
|---|---|
idea.created | A new idea has been submitted and approved |
idea.status_changed | An idea's status has been updated |
idea.voted | An idea has received a new upvote |
survey.response_created | A new response to a survey has been submitted |
announcement.published | A new announcement has been published |
customer.created | A new customer has been added to your company |
customer.approved | A customer account has been approved |
How do I verify webhook signatures?
Each webhook request includes an X-Scalar-Signature header. Verify this by computing an HMAC-SHA256 of the payload using your webhook secret and comparing it to the signature.
What happens if my webhook endpoint is down?
Scalar automatically retries failed deliveries using exponential backoff:
| Attempt | Delay |
|---|---|
| 1 | Immediate |
| 2 | After 1 minute |
| 3 | After 5 minutes |
| 4 | After 5 minutes |
After 4 failed attempts, the delivery is marked as failed. After 10 consecutive failures, the webhook endpoint is automatically disabled.
Does Scalar support SSO?
Yes. Scalar supports Single Sign-On (SSO) configuration for enterprise customers. Contact support for setup assistance.
Do webhooks require a subscription add-on?
Yes. Webhooks require a subscription add-on. Check your plan details in Settings > Billing to see if webhooks are included.