Skip to main content

Zapier - Checkify: API Documentation

The API documentation lists the available endpoints at the API being used in the integration and how to send requests to those endpoints.

Updated over 10 months ago

This document outlines the available API endpoints used for the Zapier integration with Checkify+. It is intended for Zapier's internal use or integration purposes only.

Supported Triggers

Zapier subscribes to Checkify+ platform events to trigger automated workflows:

  • Checkout Initiated

  • Order Completed

Each trigger supports the following methods:

Checkout Initiated Trigger

Subscribe to Event

Registers a webhook URL to receive Checkout Initiated event payloads.

Request Example:

{ "targetUrl": "https://hooks.zapier.com/hooks/standard/abcd1234/" }

Response:

{ "message": "Subscription for checkoutInitiated added." }

Unsubscribe from Event

Removes a registered webhook.

Request Example:

{ "targetUrl": "https://hooks.zapier.com/hooks/standard/abcd1234/" }

Response:

{ "message": "Subscription for checkoutInitiated removed." }

Get All Subscriptions

Retrieves all webhook URLs subscribed to this event.

Response:

{ "subscriptions": [ "https://hooks.zapier.com/hooks/standard/abcd1234/", "https://hooks.zapier.com/hooks/standard/efgh5678/" ] }

Order Completed Trigger

Subscribe to Event

Request Example:

{ "targetUrl": "https://hooks.zapier.com/hooks/standard/wxyz7890/" }

Response:

{ "message": "Subscription for orderCompleted added." }

Unsubscribe from Event

Request Example:

{ "targetUrl": "https://hooks.zapier.com/hooks/standard/wxyz7890/" }

Response:

{ "message": "Subscription for orderCompleted removed." }

Get All Subscriptions

Response:

{ "subscriptions": [ "https://hooks.zapier.com/hooks/standard/wxyz7890/" ] }

Example Event Payload

When a checkout is initiated, a webhook is triggered with the following sample payload:

Sample Payload (checkoutInitiated / orderCompleted)

{
"lineItems": [
{
"title": "Apple iPhone 3gs Black",
"price": 499.99,
"image": "https://cdn.shopify.com/s/files/1/0516/2831/0707/products/aglaonema-1_590x.jpg?v=1606387114",
"quantity": 2
},
{
"title": "Samsung Earbuds 3",
"price": 894.09,
"image": "https://cdn.shopify.com/s/files/1/0516/2831/0707/products/anthurium-1_370x.jpg?v=1606387387",
"quantity": 1
}
],
"itemCount": 3,
"totalPrice": 1001.44,
"currency": "USD",
"url": "https://pay.checkify.plus/checkout?id=f0863e9f-5ce9-4644-a21e-878175d7bf49",
"discountAmountInPercents": 3.5,
"discountAmount": 10,
"email": "[email protected]",
"firstName": "Name",
"lastName": "Surname",
"countryCode": "IT"
}

Note: Fields such as email, lineItems, and totalPrice may be used in Zapier actions and filters.


Additional Notes

  • Subscriptions are specific to each event type; a targetUrl must be registered separately for each.

  • The system uses a centralized internal handler (ZapierAbandonedEventHandler) to dispatch events to all subscribed endpoints.

  • No public documentation or API tokens are needed β€” this integration is entirely backend managed.

For any questions or troubleshooting, please refer to:

For additional assistance, you can also visit the Zapier Community to connect with other users and experts.

Did this answer your question?