API Documentation for Zapier Integration

This document outlines the API integration details required for TicketsCandy’s Zapier application. It provides guidance on authorization, subscription management, and available endpoints for retrieving event-related data. This documentation is intended for Zapier support teams to assist in troubleshooting and maintaining the integration.

1. Authorization #

TicketsCandy uses a token-based authentication system.

• Each API request must include an authorization token.
• The token is a 28-bit (16-byte) cryptographic token, 32 characters in length.
• The token can be passed using either:
  • The Authorization header with the Bearer scheme.
  • A POST parameter in the request body.

If the token is missing or invalid, the API returns a 401 Unauthorized response.

2. Webhooks: Subscribing & Unsubscribing #

Zapier communicates with TicketsCandy using webhooks to receive order and attendee data in real-time.

Subscription Process #

1. When a Zap is activated, Zapier sends a POST request to TicketsCandy’s webhook subscription endpoint.
2. This request contains a unique hook URL where trigger data should be sent.
3. TicketsCandy stores this hook URL and sends event-related updates to it when triggers occur.

Unsubscription Process #

1. When a Zap is deactivated, Zapier sends a DELETE request to the webhook subscription endpoint.
2. TicketsCandy verifies if the hook URL exists in the database.
3. If found, the URL is removed from the subscription list.
4. If Zapier disables a webhook, it returns a 410 Gone response.
5. TicketsCandy periodically detects and removes inactive hooks.

3. Available Endpoints #

Trigger Data Retrieval #

Zapier can retrieve historical order and attendee data using the following GET endpoints:

1. getEventOrders
   • Retrieves order details for an event.
   • Includes ticket purchase information, customer details, and transaction metadata.
2. getAttendeeOrders
   • Retrieves attendee details for an event.
   • Includes attendee names, email addresses, and check-in statuses.

Both endpoints require authentication and return data in JSON format.

Support & Troubleshooting #

For further technical support, please contact us here.