Skip to main content

​
uGiftme Zapier Integration API

Comprehensive API for integrating uGiftme gift card platform with Zapier automation workflows. This API provides both triggers (outbound webhooks) and actions (inbound operations) for automating gift card operations.

​
Features

​
Event Triggers (4 Webhook Events)

Gift Card Lifecycle:
  • gift_card_sent - Fired when a gift card is delivered to a recipient
  • gift_card_redeemed - Fired when a gift card is used/redeemed
Business Operations:
  • payment_failed - Fired when payment processing fails for a gift card order
  • wallet_funded - Fired when your business wallet is topped up with funds

​
Action Types (5 Operations)

Gift Card Management:
  • send_gift_card - Send a single gift card to a recipient
  • send_bulk_gift_cards - Send multiple gift cards to recipients in bulk
  • resend_gift_card - Resend a gift card to a recipient
Wallet Management:
  • check_wallet_balance - Check the current balance of your business wallet
  • get_wallet_transactions - Retrieve wallet transaction history

​
Dynamic Fields

  • Real-time product data for Zapier form dropdowns
  • Live denomination options based on product selection
  • Automatic validation and error handling

​
Security & Validation

  • API key authentication with UUID format
  • Webhook signature verification (HMAC-SHA256)
  • Rate limiting (100 requests/minute per API key)
  • Input sanitization and business rule enforcement

​
Getting Started

  1. Authentication: Obtain your API key from the uGiftme business dashboard
  2. Configure Webhooks: Set up webhook integration for triggers
  3. Implement Actions: Use action endpoints for automated operations
  4. Leverage Dynamic Fields: Use dynamic fields for enhanced user experience

​
Webhook Delivery

  • Signature Verification: HMAC-SHA256 with webhook secret
  • Retry Mechanism: Exponential backoff (0s, 30s, 5m)
  • Dead Letter Queue: Failed webhooks after 3 attempts
  • Delivery Confirmation: Response logging and monitoring

​
API Servers

Production Environment: Use https://api.ugift.me for live integrations Development Environment: Use https://api-stage.ugift.me for testing and development Local Development: Use http://localhost:3000 for local development only

​
Authentication

All endpoints require API key authentication using the X-API-Key header: Format: UUID format (e.g., 6b4e22b2-c0a5-4c7a-888a-b38eac20b454) Required: All endpoints require this header
Permissions: Must have business-level access with Zapier integration permissions

​
Rate Limiting

  • Rate Limit: 100 requests per minute per API key
  • Headers: Rate limit information is included in response headers
  • Middleware: zapierWebhookLimiter applies to all Zapier endpoints

​
Interactive API Documentation

The complete API specification with interactive examples is available below. You can test all endpoints directly from this documentation using the API playground.