<- Gift Card Activities webhooks

Gift Card Activities webhooks

All versions ->

gift_card activity updated

EVENT

 gift_card.activity.updated

Published when a gift card activity is updated. Subscribe to this event to be notified about the following changes:

  • An update to the REDEEM activity for a gift card redemption made from a Square product (such as Square Point of Sale). These redemptions are initially assigned a PENDING state, but then change to a COMPLETED or CANCELED state.
  • An update to the IMPORT activity for an imported gift card when the balance is later adjusted by Square.
Permissions:GIFTCARDS_READ
Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the Square seller associated with the event.

Link to section

type

string

The type of event. For this event, the value is gift_card.activity.updated.

Link to section

event_id

string

Link to section

created_at

string

Read only The timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event.