Gift Notifications Webhook Events

The gift entity has the following events:

Gift Initial Notification

Event name: gift-notification-initial

Receive this event when a gift was first created and was.

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-notification-initial",
    "target": "string",
    "triggeredAt": "2023-06-26T14:44:00.138Z"
  },
  "eventData": {
    "giftId": "string",
    "giftLink": "string",
    "sendingChannel": "string"
  }
}

Gift Reminder Notification

Event name: gift-notification-reminder

Receive this event when ever a reminder notification should have been sent for this gift. Sent according to the time that has passed from the date the gift was sent. The predefined cadence in days is: 1, 3, 7, 12, 21, 28, 35, 42, 60, 90, 120, 150, 180, 210, 240, 270

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-notification-reminder",
    "target": "string",
    "triggeredAt": "2023-06-27T12:50:40.313Z"
  },
  "eventData": {
    "giftId": "string",
    "giftLink": "string",
    "cadance": "number",
    "sendingChannel": "string"
  }
}

Gift Expiration Notification

Event name: gift-notification-expiration

Receive this event when ever an expiration notification should have been sent for this gift. Sent according to the time that is left until the expiration date. The predefined cadence in days is: 7, 1

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-notification-expiration",
    "target": "string",
    "triggeredAt": "2023-06-13T15:53:28.068Z"
  },
  "eventData": {
    "giftId": "string",
    "giftLink": "string",
    "cadance": "number",
    "sendingChannel": "string"
  }
}

Gift Resend Notification

Event name: gift-notification-resend

Receive this event when a gift is resent to the end user.

Example payload:

{
  "webhookData": {
    "id": "string",
    "eventType": "gift-notification-resend",
    "target": "string",
    "triggeredAt": "2023-06-26T14:44:00.138Z"
  },
  "eventData": {
    "giftId": "string",
    "giftLink": "string",
    "sendingChannel": "string"
  }
}