Pusher API overview

With subscriptions, the Pusher API will immediately update you of those events that are triggered on your Zettle Go. So you don't need to pull information from other Zettle Go APIs.

Zettle system overview with Pusher service.

Getting started

Register on the Zettle Developer Portal to get API credentials for the app you are building, and learn more about different types of integrations. See Get started for more information.

Explore the following sections to get an understanding of how to work with the Pusher API.

Understand how subscriptions work

The Pusher API provides events for you to listen to certain activities of the Zettle Go app at a working HTTPS endpoint on your server.

When an event that you have subscribed is triggered, the Pusher API sends the event in a POST request to the HTTPS endpoint. The HTTPS endpoint is used as the destination URL. The request contains a payload field with event information in real time.

For more information about event payloads, see event payloads.

After the Pusher API sends a POST request, if the destination URL doesn't return a valid HTTP response within 10 seconds, the request times out. Before the Pusher API deletes the subscription, it re-sends the request to the destination URL according to the retry policy.

Plan subscriptions

Before subscribing to events, plan which events to use for your use cases.

To get started, you may want to subscribe to the following events:

  • To monitor inventory changes in Zettle Point of Sales (POS): InventoryBalanceChanged, InventoryTrackingStarted, and InventoryTrackingStopped
  • To monitor product library changes: ProductCreated, ProductUpdated, and ProductDeleted
  • To monitor purchases: PurchaseCreated

For more events that you can subscribe, see Pusher API reference.

Manage subscriptions

With the Pusher API, you can create, view, update, and delete subscriptions as you need.