Skip to end of metadata
Go to start of metadata

The following methods describe how and why Wallet Item Added and Wallet Item Removed callback events are used, including examples.

The supported event_types are wallet_item_install and wallet_item_remove.

Callback Body

{
        "callback_id": 11887,
        "event_type": "wallet_item_install",
        "wallet_item_install": {
            "campaign_token": "r3zhm8"
        },
        "destination": {
            "url": "http://destination.url",
            "method": "POST",
            "content_type": "application/json"
        },
        "start_date": "2018-04-25T20:00:00Z",
        "url": "/companies/ba9bcNKc/config/callbacks/11887",
        "created_at": "2018-04-27T21:37:09Z",
        "updated_at": "2018-04-27T21:37:09Z"
    


Wallet Item Install Callback Event

This callback event is triggered when a new Wallet item has been installed for a given campaign. 

{
  {
  "event_id": "5725c57e-f4bf-47e3-8b1f-6b47e532157a",
  "event_type": "wallet_item_install",
  "event_date": "2018-05-07T15:27:33.664Z",
  "delivery_attempt":"1",
  "wallet_instance": {
    "registered_at": "2017-01-14T14:30Z",
    "unregistered_at": NULL,
    "wallet_instance_uid": "ec5035b8-349d-47e4-aef1-21bef2220c26",
    "provider": "google"
  },
  "wallet_item": {
    "uuid": "item-uuid",
    "wallet_object_uid": "j8hddfgu65-349d-47e4-aef1-5ujdf2220c26",
    "expiration_date": "2017-01-14T14:30Z",
    "tokens": {
      "first_name": "Calrissian"
    },
    "url": "/companies/bi3bwNRk/campaigns/wallet/r3zhm8/items/item-uuid"
  },
  "wallet_campaign": {
    "wallet_campaign_uid": "cc2ba6ca-557f-4335-9df0-ee5d3c541d0a",
    "token": "r3zhm8",
    "url": "/companies/bi3bwNRk/campaigns/wallet/r3zhm8/"
  }
}


Wallet Item Remove Callback Event

This callback event is triggered when a new Wallet item has been removed for a given campaign. 

{
  {
  "event_id": "5725c57e-f4bf-47e3-8b1f-6b47e532157a",
  "event_type": "wallet_item_remove",
  "event_date": "2018-05-07T15:27:33.664Z",
  "delivery_attempt":"1",
  "wallet_instance": {
    "registered_at": "2017-01-14T14:30Z",
    "unregistered_at": "2018-01-14T14:30Z",
    "wallet_instance_uid": "ec5035b8-349d-47e4-aef1-21bef2220c26",
    "provider": "google"
  },
  "wallet_item": {
    "uuid": "item-uuid",
    "wallet_object_uid": "j8hddfgu65-349d-47e4-aef1-5ujdf2220c26",
    "expiration_date": "2017-01-14T14:30Z",
    "tokens": {
      "first_name": "Calrissian"
    },
    "url": "/companies/bi3bwNRk/campaigns/wallet/r3zhm8/items/item-uuid"
  },
  "wallet_campaign": {
    "wallet_campaign_uid": "cc2ba6ca-557f-4335-9df0-ee5d3c541d0a",
    "token": "r3zhm8",
    "url": "/companies/bi3bwNRk/campaigns/wallet/r3zhm8/"
  }
}

Additional Resources

  • No labels