Integration Guide
Use this guide to plan how your application exchanges location and operational data with Posiway. REST APIs are suitable when your system needs to request or update data on demand. Webhooks are the better fit when Posiway should notify your system as soon as an alarm event is created.
Get started
- Define the accounts, devices, events, and workflows your integration needs.
- Review the API reference for documented endpoints, authentication requirements, request parameters, examples, and response models.
- Read the webhook receiver guide for signing, delivery, acknowledgement, retry, and idempotency behavior.
- Use the alarm event reference to map hardware and business alarm types to your own workflow.
Production checklist
- Keep credentials and signing secrets in a server-side secret store.
- Request the minimum permissions and account scope required by the integration.
- Preserve the raw webhook body until HMAC verification is complete.
- Deduplicate webhook deliveries with the stable event ID.
- Return a 2xx response promptly, then process long-running tasks asynchronously.
- Set explicit connection and request timeouts and use bounded retries with backoff.
- Monitor authentication failures, rejected signatures, delivery latency, duplicates, and dead-letter events.
- Test with representative devices and customer-account hierarchies before rollout.
What to prepare
Before contacting integration support, prepare the target workflow, expected data volume, destination systems, required device groups, and intended launch environment. This helps the team confirm account access, webhook subscriptions, and a safe rollout sequence without granting unnecessary permissions.
Explore the API · Implement a webhook receiver · Contact support