Gift Webhook Events

The gift entity has the following events:

Gift Status Changed

Event name: gift-status-changed

Receive this event when a gift status has changed.

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-status-changed",
    "target": "string",
    "triggeredAt": "2023-06-26T14:44:00.138Z"
  },
  "eventData": {
    "companyId": "string",
    "giftId": "string",
    "status": "opened"
  }
}

Gift Delivery Status Changed

Event name: gift-delivery-status-changed

Receive this event when a gift delivery status has changed.

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-delivery-status-changed",
    "target": "string",
    "triggeredAt": "2023-06-27T12:50:40.313Z"
  },
  "eventData": {
    "companyId": "string",
    "giftId": "string",
    "deliveryStatus": "outForDelivery",
    "outForDeliveryDate": "2023-06-01T08:00:00.000Z"
  }
}

Invoice Sent

Event name: gift-invoice-sent

Receive this event when a gift invoice has been

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-invoice-sent",
    "target": "string",
    "triggeredAt": "2023-06-13T15:53:28.068Z"
  },
  "eventData": {
    "companyId": "string",
    "invoiceId": "string"
  }
}