PIING
Reading Developers (API and webhooks)Developer overview
Developers (API and webhooks)
- Developer overview
- Webhooks
- Receiving events
- API access
In this guide
- How integrations work
- What you can build against
- Is there a public REST API?
- A note on data
- Where to go next
Search or browse documentation
Developers (API and webhooks) 1 / 4
Developer overview
How to build on Piing. The main integration surface is signed events delivered to your endpoints; broader API access is available by request.
Piing is event driven. When something happens in store or in your commerce platform, such as a customer tapping in or an order being paid, Piing emits a typed event. The main way to build a custom integration is to receive those events at an endpoint you control.
This article is the starting point. The rest of this category covers the detail.
How integrations work
Piing sits between your hardware, your commerce platform, and the tools you already use. Events flow out from Piing to the destinations you connect, such as a loyalty platform, a CRM, an email tool, or a plain webhook endpoint of your own.
For your own integration, the relevant destination type is a webhook. You give Piing a URL, Piing posts a JSON event envelope to it whenever a matching event fires, and your service does the rest.
What you can build against
- The event catalogue. A defined set of events, each with a type, a description, and a sample payload. The cornerstone is
piing.checkin.created, fired when a customer taps in. See Webhooks for the full list and payload shapes.
- The webhook delivery contract. How events are delivered, how delivery is retried, and how to make your handler safe to call more than once. See Receiving events.
Is there a public REST API?
There is no public self serve REST API for arbitrary reads and writes today. The supported, documented surface is the outbound event stream described above. If your use case needs programmatic API access beyond webhooks, that can be arranged. See API access.
A note on data
Event payloads are designed around the same data minimisation principles as the rest of Piing. Where an event carries customer detail, it carries only what a destination needs to act, and identity enrichment is applied per destination rather than broadcast everywhere. For the wider picture, see What data Piing stores.
Where to go next
- Webhooks: the events and their payloads.
- Receiving events: consuming events, retries, and verification.
- API access: requesting access for use cases webhooks do not cover.
If you are scoping an integration and want to talk it through, contact us.
Related guides
Was this guide helpful?
Next guide in Developers (API and webhooks)
Webhooks
The events Piing emits and the JSON payload shape they arrive in, including the check-in event and the generic webhook envelope.
Still need a hand? Contact us