API Workflows

Webhook & Polling Fulfillment Tracking

Monitor reward order status with real-time webhooks or polling to track fulfillment through completion.

Overview

Common tracking scenarios include:

  • Monitoring reward delivery status
  • Handling asynchronous order completion
  • Updating internal systems when fulfillment is complete
  • Tracking large or bulk order progress
  • Ensuring reliable reward delivery

Instead of relying only on immediate responses, systems can track fulfillment through events or periodic checks.

How the API is Used

  • Receive real-time notifications via webhook using FulfillmentComplete
  • Poll order status using the Orders endpoint
  • Track order lifecycle from Pending to Completed
  • Integrate fulfillment updates into your system workflows

Example Workflow

  • Your system submits an order via the API
  • The API processes the order and may do so asynchronously
  • A webhook is triggered when fulfillment is complete
  • Alternatively, your system polls the order status
  • Your system updates based on the final status

API Integration Flow

API Integration Flow

1
Authenticate
POST /v1/Tokens
2
Send order
POST /v1/Orders
3
Receive webhook
FulfillmentComplete event
4
Or poll status
GET /v1/Orders/{id}

Example Request

JSON
{
  "Type": "DigitalDelivery",
  "LineItems": [
    {
      "ProductId": "CVS",
      "Value": 20,
      "Quantity": 1,
      "DigitalDeliveryAddress": {
        "Email": "user@email.com"
      }
    }
  ],
  "WebhookSettings": {
    "FulfillmentComplete": "https://yourapp.com/webhook"
  },
  "PONumber": "TRACK-18001"
}

Delivery Options

  • DigitalDelivery – Track digital fulfillment status
  • Links – Monitor claim link generation
  • PhysicalShipment – Track shipment-related fulfillment progress

Benefits

  • Provides real-time or on-demand visibility into order fulfillment
  • Supports reliable system updates for asynchronous orders
  • Improves operational transparency
  • Helps ensure rewards are fully delivered before downstream actions

Compliance Considerations

  • Secure and validate webhook endpoints
  • Log tracking events for audit purposes
  • Implement retry-safe handling for duplicate notifications

Common Program Types

  • Asynchronous order workflows
  • Bulk reward programs
  • Enterprise system integrations
  • Operational monitoring and fulfillment tracking