Offer Webhooks

Triggering Events

Below are the following events that trigger Offer's webhooks. In the springbig database offers are synonymous to reward_grants

On Creation: reward_grant_created

{
   "reward_grant":{
      "merchant_id":420,
      "member_id":1216000,
      "member_email":"[email protected]",
      "member_phone_number":"814-420-4200",
      "created_at":"2023-06-28T16:00:06Z",
      "communication_id":1387,
      "communication_type":"Campaign",
      "offers":[
         {
            "id":1337101,
            "active":true,
            "status":"issued",
            "_type":"coupon",
            "max_redemptions":-1,
            "expiration":"2023-07-01T03:59:59.000Z",
            "name":"webhook testing",
            "description":null,
            "offer_type":"coupon",
            "item_value":0,
            "bonus_type":null,
            "bonus_value":null,
            "cash_reward":false,
            "meta":null,
            "discount_amount":null,
            "discount_type":null,
            "images":[
               
            ]
         }
      ]
   },
   "event_name":"reward_grant_created"
}

Attribute	Definition	Sample Response
merchant_id	the member's merchant's account id
member_id	the member's unique identifier
member_email	the member's email address	valid email format
member_phone_number	the member's phone number as a string value	valid 10-digit number e.g. 814-420-4200
created_at	the timestamp of the reward_grant
communication_id	the index id relevant to the communication type	integer, null
communication_type	the communication source of the reward grant	Campaign, AutoCampaignMessage, ExternalSubscriptionPlan, null

Communication_type + Communication_id expanded

The communication type indicates the communication source where the offer (reward_grant) was created.

when type: Campaign, the identifier (id) refers to the campaign_id
when type: AutoCampaignMessage, the identifier (id) refers to the autoconnect.message_id
when type: ExternalSubscriptionPlan, the identifier (id) refers to the subscription_plan.id
when type: Null, there is no message identifier because this offer was not triggered by a message type. This offer is a standalone offer that is not linked to any messages. The feature that supports this offer is called "Member Offers"

Offers

Attribute	Definition	Sample Response
id	the offer (reward_grant) unique identifier
active	boolean that determines the state of the offer - when an offer is issued, the value will remain `true`	true, false
status	the status of the offer when it is triggered to a customer	issued
_type	the offer type can be a coupon: defined discount, bonus_point: point multiplier, instant_point: issues points when the customer meets criteria (instant points are only supported through communication_type offers)	coupon, bonus_point, instant_point
max_redemptions	an integer that defines the max redemptions allowed to be redeemed. -1 = unlimited	1-10, -1
expiration	the date that the offer is set to expire in UTC format
name	the name of the offer
description	a description was added to the offer
offer_type	offertype = type
item_value	defaults to 0 - this value is only respected for rewards, not offers
bonus_type	determines if the mounts are added or multiplied to a sale, only relevant to a bonus type offer	add, multiply
bonus_value	the number of points to be earned if type: bonus
cash_reward	boolean if the offer is a cash reward (only relevant to rewards) - offer default to false	false
meta	an arbitrary value that is determined between POS + springbig for in-store redemptions
discount_amount	a defined discount amount as an integer
discount_type	the discount type can be percentage or dollar	%, $
images	an array of image links if an image is attached to an offer
event_name	currently support creating events only	reward_grant_created