API Guide
Webhooks API
Endpoint reference for developer webhook management plus partner webhook subscriptions, tests, and delivery event logs.
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
SoundSync
Developer webhook endpoints
Developer console webhook routes require a signed-in developer account.
/api/developer/webhook
List or create developer webhook endpoints from the developer console.
- Auth
- Developer account token
- Scope
- Product or storefront scoped
- Request fields
- POST accepts webhook URL and event configuration supported by the API.
- Returns
- Webhook list or created webhook.
/api/developer/webhook/:id/secret
Return the signing secret for a developer webhook.
- Auth
- Developer account token
- Scope
- Product or storefront scoped
- Returns
- Webhook signing secret for the selected endpoint.
/api/developer/webhook/:id/test
Send a developer webhook test event.
- Auth
- Developer account token
- Scope
- Product or storefront scoped
- Request fields
- Test event payload.
- Returns
- Webhook test result.
/api/developer/webhook/:id
Delete a developer webhook endpoint.
- Auth
- Developer account token
- Scope
- Product or storefront scoped
- Returns
- Deletion result.
SoundSync
Partner webhook endpoints
Partner webhook routes require partner API key scopes.
/api/partner/v1/webhooks
List or create partner webhook subscriptions.
- Auth
- Partner API key
- Scope
- webhooks:read or webhooks:write
- Request fields
- For POST: url, event types, status, and signing/configuration fields supported by the service.
- Returns
- Webhook subscription list or created subscription.
/api/partner/v1/webhooks/:webhookId
Update or delete a partner webhook subscription.
- Auth
- Partner API key
- Scope
- webhooks:write
- Request fields
- status/url/event configuration for PATCH.
- Returns
- Updated or deleted webhook subscription state.
/api/partner/v1/webhooks/test
Create a test partner webhook event.
- Auth
- Partner API key
- Scope
- webhooks:write
- Request fields
- Event type and payload metadata supported by the service.
- Returns
- Test event result.
/api/partner/v1/webhooks/:webhookId/test
Send a test event through a specific partner webhook.
- Auth
- Partner API key
- Scope
- webhooks:write
- Request fields
- status and event metadata where supplied.
- Returns
- Test event result.
/api/partner/v1/webhook-events
List partner webhook delivery events.
- Auth
- Partner API key
- Scope
- webhooks:read
- Request fields
- Query filters supported by webhook event listing.
- Returns
- Webhook event log rows.
SoundSync
Webhook handling
Production webhook consumers should verify signatures, use idempotency on their side, and tolerate retries.
| Practice | Why it matters |
|---|---|
| Verify signing secret | Confirms the event came from the configured SoundSync webhook. |
| Store processed event ids | Prevents duplicate fulfillment if a webhook is retried. |
| Return fast 2xx responses | Keeps delivery healthy while heavier work runs in your system. |
| Use test endpoints | Confirms URL, auth, and event parsing before launch. |