Event Overview - Gift created

Target Audience: Users, Developers, Stakeholders

Introduction

This document defines the event gift_created.

Description

This event is triggered when a gift v1 order is completed.

Warning

This event is deprecated and should be replaced by gift_order_closed.

Listeners

Listeners available to the event.

Webhook

This event can be listened to using webhooks. To register your webhook please contact support.

Payload emitted

{
  "event": "gift_created",
  "timestamp": "2021-03-22T15:52:14.775Z",
  "payload": {
    "account": {
      "id": "6058bd2e09c04c1c5260fd7e",
      "organisation_id": "organisation",
      "first_name": "",
      "last_name": "",
      "contact_email": "user@email.com",
      "mobile_number": null,
      "alias": "",
      "customer_number": "",
      "birth_date": "",
      "ssn": "",
      "status": "active",
      "loyalty_card_number": "",
      "account_origin": "",
      "verified": false,
      "created": "2021-03-22T16:52:14+01:00",
      "updated": "2021-03-22T16:52:14+01:00",
      "confirmation_code": "",
      "contact_email_for_update": "",
      "contact_email_update_code": "",
      "address": {
        "id": "6058bd2e09c04c1c5260fd7f",
        "first_name": "Kalle",
        "last_name": "Anka",
        "street": "The Streets",
        "street_number": "12",
        "staircase": "A",
        "floor": "3",
        "apartment_number": "13",
        "zip_code": "83242",
        "city": "Stockholm",
        "mobile_number": null,
        "phone_number": "50460531",
        "email": "user@email.com",
        "country_code": "SE"
      },
      "gender": ""
    },
    "order": {},
    "payment": {},
    "receipt": {},
    "share": {},
    "user_product": {},
    "new_user_product": {},
    "gift": {
      "gift_code": "64d9c74f-4661-4e54-9336-0704dc682457",
      "receiver_first_name": "john",
      "receiver_last_name": "receiver",
      "receiver_contact_email": "john.receiver@adeprimo.se",
      "gift_url": "redeem_gift_url"
    },
    "product": {
      "product_code": "campaign_code",
      "name": "product_name",
      "valid_from": "2020-03-22T16:52:14.748+01:00",
      "valid_to": "2022-03-22T16:52:14.748+01:00"
    },
    "payment_retry": {},
    "event_data": {},
    "payment_about_to_expire": {}
  }
}

Legacy e-mail

This event is supported by the transactional e-mailing system built into Payway.

Third-party e-mail

This event is supported by third party e-mailing systems such as Rule.