offer_updated

When it fires

This event is triggered when an offer of the loyalty programme is created or updated.

Payload fields

Field	Type	Description
event	String	The name of the webhook event.
shoppingHubId	String	Programme id (Spaycial).
shoppingHubExternalId	String	Programme id in your system.
offer	Object	The offer that was created or updated.
offer.id	String	The offer identifier.
offer.status	String	The status of the offer: created or updated.
offer.startDate	Date	The offer's start date-time (RFC 3339 full-date format).
offer.endDate	Date	The offer's end date-time (RFC 3339 full-date format).
offer.name	String	The offer's name.
offer.teaser	String	The offer's teaser.
offer.rewardType	String	The type of benefit unlocked by this offer: LTRY (lottery), RFND (refund in cashback), GIFT_CARD (gift card).
offer.offerType	String	The kind of purchase trigger the offer looks for: welcome, frequency, referral, average.
offer.rewardLabel	String	The offer's reward description.
offer.rewardValue	String	The offer's reward value.
offer.conditionLabel	String	The condition to complete the offer, as a label.
offer.conditionValue	String	The condition to complete the offer, as a value.
offer.active	Boolean	Whether the offer is active.

Example

{
    "event": "offer_updated",
    "shoppingHubExternalId": "90890289082",
    "shoppingHubId": "492f0b39-c205-4fb2-a225-70e042df3fdb",
    "offer": {
        "id": "4f284506-f8e8-486a-994a-2fa0f62838e5",
        "status": "created",
        "startDate": "2023-05-31T22:00:00.000Z",
        "endDate": "2023-06-30T22:00:00.000Z",
        "name": "June 2023 offer",
        "teaser": "Offre du mois de juin",
        "offerType": "frequency",
        "rewardType": "RFND",
        "rewardLabel": "10 €",
        "rewardValue": "10.00",
        "conditionLabel": "Recevez 10€ pour 80€ d'achats cumulés",
        "conditionValue": "80.00",
        "active": true
    }
}

Related

• List offers
• reward_updated