What arrives
- Read. Your projects, and feedback with filters for project, status and date, with every detail of each item.
- Update. Change an item's status, for example when the fix ships in your own tool.
- Events. New feedback, a status change and an answered change request, each sent as it happens and signed so you can check it came from us.
- Retries. A delivery that fails is retried five times over about nine hours.
POST https://your-app.example/hooks
{
"type": "feedback.created",
"data": {
"item": {
"number": 14,
"comment": "The signup button is cut off on my phone.",
"page_path": "/pricing/",
"status": "new",
"scope": "unreviewed"
}
}
}How it fits your workflow
The API is for the tools we don't connect to directly: your own dashboard, a reporting sheet, a CRM, or an internal tool your team built. Read every project and piece of feedback with the same details you see in Scopepin, and change an item's status when work is done somewhere else.
Webhooks push events to you instead of you asking for them. Subscribe an address to new feedback, status changes or answered change requests, and each event arrives as a signed POST with the item or change request in the body. Check the signature with your secret to know it came from us, and answer with any 2xx.
A common setup: new feedback creates a row in your project tracker, a status change updates it, and an answered change request adds the approved amount to your invoicing tool. The full reference, with every path, field and a signature example, is on the API page inside the dashboard.
Setup
Set it up in a couple of minutes
- 1
Create an API key
The workspace owner opens Integrations in Scopepin and creates a key under API and webhooks.
- 2
Call the API
Send the key as a bearer token. The reference on the same page lists every path and field.
- 3
Subscribe to events
Register the address that should receive events and keep the signing secret to check each delivery.
If something isn't working
- Calls return 401
- The key is missing, mistyped or revoked. Send it as "Authorization: Bearer spk_…" and create a new key if you've lost it: only its fingerprint is stored.
- Calls return 429
- You've passed 120 calls a minute for that key. Wait a moment and retry, or use webhooks instead of polling.
- The signature doesn't match
- Sign the raw request body exactly as received, prefixed with the timestamp and a dot, using the webhook's own secret.
- Webhooks stopped arriving
- A webhook is switched off after a 410 answer or 50 failed deliveries. Subscribe the address again once it's answering.
Questions
Which plans include the API?
Pro and Agency.
Is there a rate limit?
120 calls a minute per key.
Do you work with Zapier or Make?
Apps for both are in review. Until they're listed, the API and webhooks cover the same triggers and actions.
Can I revoke a key?
Yes. Revoke it on the Integrations page and it stops working at once.
Which events are there?
feedback.created, feedback.status_changed and change_request.answered. Each delivery is retried if it fails: after 1, 5 and 30 minutes, then 2 and 6 hours.
Other integrations
Client feedback, straight into your own tools.
Start free with one project. API and webhooks comes with Pro and Agency.