Order category events

The following webhook events are currently under Order category:

Asynchronous order status

Tango supports webhook notification for asynchronous order status. You can receive a notification via a webhook event when your asynchronous order has completed processing—whether it was successful, retrying, failed, or partially failed.

Use case

Acme Wellness has submitted a large batch order for digital wellness gift cards (e.g., as part of a corporate wellness program) and wants to be automatically notified when a bulk gift card order, submitted asynchronously via the Tango API, has finished processing—whether it was successful, failed, retrying, or partially failed.

Here is the response payload:

{
"category": "ORDER",
"eventTypes": "AsyncOrderStatus"
"eventOccurredAt": "2024-11-09T04:25:36.4844028Z",
"eventData": {
          “externalRefID”: “string”,
          ”customerIdentifier”: “string”,
          ”accountIdentifier": "string",
          "referenceOrderID": "string,
          "status": "SUCCESSFUL", “RETRYING”, “FAILED”, “PARTIALFAILED”
    }
}

Line item delivery status for physical gift cards

Tango supports line item delivery status for physical gift cards. Subscribing to the LineItemDeliveryStatus event ensures that you receive timely notifications when a line item delivery status changes, such as from In Progress to Shipped, etc. To subscribe to line item delivery status events, create a subscription using POST {URI}/webhooks, with an eventTypes = LineItemDeliveryStatusand categories= ORDER`.

Use case

Acme, a wellness incentive company, uses Tango’s LineItemDeliveryStatus webhook to monitor the delivery progress of physical gift cards. By subscribing to this event, Acme receives real-time updates when a line item’s delivery status changes from In Progress to Shipped, for example. This event allows Acme to keep recipients informed and manage delivery expectations effectively.

List of line item delivery statuses

The following statuses may be returned with thelineItemDeliveryStatus:

Line item delivery status	Description
IN_PROGRESS	The order is currently processing.
SHIPPED	The order has shipped.
COMPLETED	The order was completed and fulfilled successfully. This is the final status for a successfully delivered order.
CANCELED	Your order was canceled before fulfillment.
FAILED	The line item has failed and cannot be sent. Not all the records in the order could be funded, reserved, or processed. The order has not been fulfilled or was declined before being fulfilled. An order using a real-time API failed. This is a final status. The order must be resubmitted. The order payment could not be completed. The order has not been fulfilled. An error was encountered when placing the order. The order was not fulfilled.

Here is a response payload of LineItemDeliveryStatusevent:

{
  "eventId": "2e3b91ba-4d6a-43b5-8e77-3b31e3f938b3",
  "revision": 4,
  "category": "ORDER",
  "eventType": "LineItemDeliveryStatus",
  "eventOccurredAt": "2024-06-17T17:10:00.759273600Z",
  "eventData": {
    "referenceLineItemId": "RA240828-128134-15-1",
    "status": "In Process"
  }
}