Zapier is a platform that enables you to automate many tasks with a simple UI interface without requiring developer expertise.

We have built a dedicated Zapier app that connects to your Zaprite account and offers a set of Triggers and Actions that can be used to create powerful automations.

Create a Zaprite API Key

First, navigate to Settings > API in your Zaprite account and click [ + Add API key ]. Give your new key a Label and then click [ Save ].

TIP: You can create a test API Key in a Sandbox Organization to test automations with simulated payments before adding a live API Key.

Add the Zaprite App to your Zapier Account

The next step involves adding the Zaprite app to your Zapier account. Start by visiting the App Connections page in Zapier and clicking the [ + Add connection ] button.

Search for 'Zaprite' and select the result shown and then click [ + Add connection ]. This will open a new window asking for your Zaprite API Key.

Add your Zaprite API Key to Zapier

In the new window, paste in your Zaprite API Key and click [ Yes, Continue to Zaprite]. This will allow our Zapier App to communicate with Zaprite's servers to read data and perform actions that you have configured.

Setup your Zapier automations

You now have your Zaprite account connected to Zapier and can setup custom automations.

Triggers

The following Triggers are available in our Zapier App:

Order Changed	Triggers when an Order is created or updated (status change, payment, etc.).
Invoice Order Changed	Triggers when an Invoice is created or updated (status change, payment, etc.).
Invoice Paid	Triggers when an Invoice is paid in full.
Invoice Underpaid	Triggers when an Invoice receives a payment less than the total amount.
Invoice Overpaid	Triggers when an Invoice receives a payment more than the total amount.
Invoice Sent	Triggers when an Invoice is sent to a customer.
Payment Link Order Changed	Triggers when a Payment Link Order is created or updated (status change, payment, etc.).
Payment Link Paid	Triggers when a Payment Link Order is paid in full.
Payment Link Underpaid	Triggers when a Payment Link Order receives a payment less than the total amount.
Payment Link Overpaid	Triggers when a Payment Link Order receives a payment more than the total amount.
Ticket Order Paid	Triggers when an Event Ticket Order is paid in full and returns the tickets for that order.
Ticket Order Underpaid	Triggers when a Event Ticket Order is underpaid and returns the tickets for that order.
Ticket Order Overpaid	Triggers when a Event Ticket Order is overpaid and returns the tickets for that order.
POS Order Changed	Triggers when a Point of Sale Order is created or updated (status change, payment, etc.).
POS Order Paid	Triggers when a Point of Sale Order is paid in full.
POS Order Underpaid	Triggers when a Point of Sale Order receives a payment less than the total amount.
POS Order Overpaid	Triggers when a Point of Sale Order receives a payment more than the total amount.
Contact Updated	Triggers when a Contact is created or updated.
Payment Profile Created	Triggers when a Contact saves a new payment method.
Payment Profile Updated	Triggers when a Contact updates a saved payment method.

Actions

The following Actions are available in our Zapier App:

Create Contact	Create a Zaprite Contact. You can then link this Contact to Zaprite Orders.
Delete Contact	Delete a Zaprite Contact
Update Contact	Update a Zaprite Contact. Only provided fields are updated.
Pay Order	Pay an Order with a Payment Profile previously saved by your Contact.
Edit Order	Update Order `status` and `expiresAt`. Status updates are equivalent to using "Mark as Complete" in the Zaprite dashboard. When setting expiration to the past, new payments are prevented but in-flight payments will still be processed.
Create Order	Create a simple Zaprite Order without `invoice` fields. Use this for the standard non-invoice API Order flow.
Create Invoice	Create an invoice-backed Zaprite Order using the same Order creation API. Include `lineItems` in the `invoice` object and a Contact to generate the Invoice details.

Searches

The following Searches are available in our Zapier App:

Get Contact	Get a Zaprite Contact by its internal Zaprite ID. If you need to find a Contact by `email`, use List Contacts instead.
List Contacts	Search and list Zaprite Contacts. Use this to find Contacts by email address or search query. Returns up to 100 Contacts per request.
Get Order	Get an Order by either it's Zaprite ID or your own ID (`externalUniqId`)
List Orders	Retrieve a paginated list of Orders with support for full-text search and filtering by date, status, currency, or contact. Returns up to 100 results per page. *
Find Transactions by Order	Finds all transactions for a given order ID.

* To reduce noise, PENDING Orders are excluded by default. To view them, explicitly set includePending=true or filter by a specific status (which overrides this default).

How to Connect Zaprite to Zapier