.public-content{max-width:860px;margin:48px auto;padding:0 24px 64px;color:#242424;font:16px/1.65 Geist,Arial,sans-serif}.public-content h1,.public-content h2{font-family:"Instrument Serif",Georgia,serif;font-weight:400;line-height:1.15}.public-content h1{font-size:42px}.public-content h2{font-size:32px;margin-top:48px}.public-content h3{font-size:20px;margin-top:32px}.public-content a{color:inherit;text-underline-offset:4px}.public-content table{border-collapse:collapse;display:block;overflow-x:auto}.public-content td,.public-content th{padding:12px;border:1px solid #ddd}.public-content dt{font-weight:600}.public-content dd{margin:0 0 16px}.public-content nav{margin-top:48px;border-top:1px solid #ddd;padding-top:24px}.public-content-brand{font-weight:600;text-decoration:none}.public-content ul{padding-left:24px}@media(max-width:600px){.public-content{margin:24px auto;font-size:15px}.public-content h1{font-size:34px}.public-content h2{font-size:28px}}PIING

Reading Developers (API and webhooks)API access

Developers (API and webhooks)

In this guide

What is available now
Is there a public REST API?
Requesting access

Search or browse documentation

Developers (API and webhooks) 4 / 4

API access

Piing's supported developer surface is the outbound event stream. There is no public self-serve REST API today; broader access is available by request.

This article explains what is available to developers today and how to ask for more if you need it.

What is available now

The supported, documented developer surface is the outbound event stream. Piing emits typed events and delivers them to the destinations you connect, including a plain webhook endpoint of your own. This is described in:

For most integrations, receiving events is enough. You react to a check-in, an attributed purchase, or a wallet pass install, and your own system takes it from there.

Is there a public REST API?

There is no public self serve REST API for arbitrary reads and writes at this time. We would rather point you at what exists than list endpoints that are not available. If you have seen a reference to an endpoint that is not documented here, treat this article as the source of truth.

The outputs Piing produces are written to records you already own, such as Shopify metafields, so in many cases the data you would want to read is available through your commerce platform's own API rather than through Piing.

Requesting access

If your use case needs programmatic access beyond webhooks, for example a server to server read, that can be arranged on a case by case basis.

To request access:

Go to contact us.
Describe what you are building and which data or actions you need.
Note your platform and the systems you want to connect.

We will come back to you with what is possible and the right way to set it up.

Note

If you are not sure whether webhooks cover your case, describe the outcome you want rather than the endpoint you think you need. Often an event you have not enabled yet is the simplest answer.

To get started, contact us.

Related guides

Was this guide helpful?

You’ve reached the end of Developers (API and webhooks).

Still need a hand? Contact us