Offer Activity Events

The following section describes event types related to offer activities within the Sparkfly platform. These events are triggered in various scenarios involving offers, such as when offers are redeemed, issued, expired or voided. Most of these events are centered on a standard offer activity object, which captures the details of the offer activity that occurred. Different activity types have different relevant fields within the offer activity object.

sf.offer_activity.created

Fired when an offer activity is created in the Sparkfly system. This event includes detailed information about the offer activity, including the type of activity (e.g., redemption, issuance), associated member, offer details, and timestamps.

Example payload (Issued):

{
    "event_name": "sf.offer_activity.created",
    /* ... standard event metadata fields ... */
    "data": {
        "activity_type": "Issued",
        "member": {
            "id": 385765107,
            "identifier": "9ecbafd1-1234-4629-b4b4-acb91967f96f" 
        },
        "offer_state": {
            "created_at": "2024-05-20T15:22:55Z",
            "id": 1138405794,
            "credential_identifier": "3KCXK6",
            "external_ref_id": "",
            "expiration": "2027-10-31T12:00:00Z"
        },
        "campaign": {
            "id": 2,
            "name": "Sample Campaign",
            "xid": "D5e7F",
            "external_id": "2222"
        },
        "offer": {
            "id": 2,
            "name": "Sample Offer", 
            "description": "Offer description"
        }
    }
}

Example payload (voided):

{
    "event_name": "sf.offer_activity.created",
    /* ... standard event metadata fields ... */
    "data": {
        "activity_type": "Voided",
        "member": {
            "id": 385765107,
            "identifier": "9ecbafd1-1234-4629-b4b4-acb91967f96f" 
        },
        "offer_state": {
            "created_at": "2024-05-20T15:22:55Z",
            "id": 1138405794,
            "credential_identifier": "3KCXK6",
            "external_ref_id": "",
            "expiration": "2027-10-31T12:00:00Z"
        },
        "campaign": {
            "id": 2,
            "name": "Sample Campaign",
            "xid": "D5e7F",
            "external_id": "2222"
        },
        "offer": {
            "id": 2,
            "name": "Sample Offer", 
            "description": "Offer description"
        }
    }
}

Example payload (Expired):

{
    "event_name": "sf.offer_activity.created",
    /* ... standard event metadata fields ... */
    "data": {
        "activity_type": "Expired",
        "member": {
            "id": 385765107,
            "identifier": "9ecbafd1-1234-4629-b4b4-acb91967f96f" 
        },
        "offer_state": {
            "created_at": "2024-05-20T15:22:55Z",
            "id": 1138405794,
            "credential_identifier": "3KCXK6",
            "external_ref_id": "",
            "expiration": "2027-10-31T12:00:00Z"
        },
        "campaign": {
            "id": 2,
            "name": "Sample Campaign",
            "xid": "D5e7F",
            "external_id": "2222"
        },
        "offer": {
            "id": 2,
            "name": "Sample Offer", 
            "description": "Offer description"
        }
    }
}

Example payload (Redeemed):

{
    "event_name": "sf.offer_activity.created",
    /* ... standard event metadata fields ... */
    "data": {
        "activity_type": "Redeemed",
        "member": {
            "id": 385765107,
            "identifier": "9ecbafd1-1234-4629-b4b4-acb91967f96f" 
        },
        "offer_state": {
            "created_at": "2024-05-20T15:22:55Z",
            "id": 1138405794,
            "credential_identifier": "3KCXK6",
            "external_ref_id": "",
            "expiration": "2027-10-31T12:00:00Z"
        },
        "campaign": {
            "id": 2,
            "name": "Sample Campaign",
            "xid": "D5e7F",
            "external_id": "2222"
        },
        "offer": {
            "id": 2,
            "name": "Sample Offer", 
            "description": "Offer description"
        },
        "transaction": {
            "id": 123
        }
    }
}

Transactions

Loyalty