📦Webhook payloads

A coupon is being validated

{
    "campaign": {
        "id": 1,
        "name": "Campaign Name",
        "code": "",
        "slug": "campaign-name",
        "campaign_type": "instant_draw",
        "start_at": "2022-02-02T17:00:00.000000Z",
        "end_at": "2024-02-10T16:59:59.000000Z",
        "logo": null,
        "is_active": 1,
        "welcome_screen_before_campaign": null,
        "welcome_screen_during_campaign": null,
        "welcome_screen_after_campaign": null,
        "result_screen_win": null,
        "result_screen_not_win": null,
        "security_option": "unique_codes",
        "security_coupon_set_id": 13,
        "domains": null,
        "created_at": null,
        "updated_at": "2023-02-14T07:22:08.000000Z",
        "deleted_at": null,
        "use_webhook_for_rules": 1,
        "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
        "settings": {
            "limit_participants_win": "1"
        },
        "description": null,
        "use_leaderboard": 0
    },
    "coupon_code": "ABCDEF"
}

A user/participant has filled the form, a coupon might also be claimed

{
    "campaign": {
        "id": 1,
        "name": "Campaign Name",
        "code": "",
        "slug": "campaign-name",
        "campaign_type": "instant_draw",
        "start_at": "2022-02-02T17:00:00.000000Z",
        "end_at": "2024-02-10T16:59:59.000000Z",
        "logo": null,
        "is_active": 1,
        "welcome_screen_before_campaign": null,
        "welcome_screen_during_campaign": null,
        "welcome_screen_after_campaign": null,
        "result_screen_win": null,
        "result_screen_not_win": null,
        "security_option": "unique_codes",
        "security_coupon_set_id": 13,
        "domains": null,
        "created_at": null,
        "updated_at": "2023-02-14T07:22:08.000000Z",
        "deleted_at": null,
        "use_webhook_for_rules": 1,
        "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
        "settings": {
            "limit_participants_win": "1"
        },
        "description": null,
        "use_leaderboard": 0
    },
    "redemption": {
        "id": 1,
        "coupon_code": "AS452DJ",
        "reward_id": 1,
        "name": "User 1",
        "email": "[email protected]",
        "phone": "08XXXXXXXXX",
        "id_number": "08XXXXXXXXXXXXX",
        "address": "Jl. Raya Tajur",
        "province_id": 00,
        "city_id": 0000,
        "district_id": 0000000,
        "created_at": "2022-09-21T08:13:31.000000Z",
        "updated_at": "2022-10-10T09:36:18.000000Z",
        "status_code": "rewarded",
        "zip_code": null,
        "campaign_id": 1,
        "user_id": null,
        "participant_id": 1
    }
}

A user/participant is starting the prize draw

{
    "campaign": {
        "id": 1,
        "name": "Campaign Name",
        "code": "",
        "slug": "campaign-name",
        "campaign_type": "instant_draw",
        "start_at": "2022-02-02T17:00:00.000000Z",
        "end_at": "2024-02-10T16:59:59.000000Z",
        "logo": null,
        "is_active": 1,
        "welcome_screen_before_campaign": null,
        "welcome_screen_during_campaign": null,
        "welcome_screen_after_campaign": null,
        "result_screen_win": null,
        "result_screen_not_win": null,
        "security_option": "unique_codes",
        "security_coupon_set_id": 13,
        "domains": null,
        "created_at": null,
        "updated_at": "2023-02-14T07:22:08.000000Z",
        "deleted_at": null,
        "use_webhook_for_rules": 1,
        "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
        "settings": {
            "limit_participants_win": "1"
        },
        "description": null,
        "use_leaderboard": 0
    },
    "redemption": {
        "id": 1,
        "coupon_code": "AS452DJ",
        "reward_id": 1,
        "name": "User 1",
        "email": "[email protected]",
        "phone": "08XXXXXXXXX",
        "id_number": "08XXXXXXXXXXXXX",
        "address": "Jl. Raya Tajur",
        "province_id": 00,
        "city_id": 0000,
        "district_id": 0000000,
        "created_at": "2022-09-21T08:13:31.000000Z",
        "updated_at": "2022-10-10T09:36:18.000000Z",
        "status_code": "rewarded",
        "zip_code": null,
        "campaign_id": 1,
        "user_id": null,
        "participant_id": 1
    }
}

A user/participant is awarded a prize from the draw

{
    "campaign": {
        "id": 1,
        "name": "Campaign Name",
        "code": "",
        "slug": "campaign-name",
        "campaign_type": "instant_draw",
        "start_at": "2022-02-02T17:00:00.000000Z",
        "end_at": "2024-02-10T16:59:59.000000Z",
        "logo": null,
        "is_active": 1,
        "welcome_screen_before_campaign": null,
        "welcome_screen_during_campaign": null,
        "welcome_screen_after_campaign": null,
        "result_screen_win": null,
        "result_screen_not_win": null,
        "security_option": "unique_codes",
        "security_coupon_set_id": 13,
        "domains": null,
        "created_at": null,
        "updated_at": "2023-02-14T07:22:08.000000Z",
        "deleted_at": null,
        "use_webhook_for_rules": 1,
        "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
        "settings": {
            "limit_participants_win": "1"
        },
        "description": null,
        "use_leaderboard": 0
    },
    "redemption": {
        "id": 1,
        "coupon_code": "AS452DJ",
        "reward_id": 1,
        "name": "User 1",
        "email": "[email protected]",
        "phone": "08XXXXXXXXX",
        "id_number": "08XXXXXXXXXXXXX",
        "address": "Jl. Raya Tajur",
        "province_id": 00,
        "city_id": 0000,
        "district_id": 0000000,
        "created_at": "2022-09-21T08:13:31.000000Z",
        "updated_at": "2022-10-10T09:36:18.000000Z",
        "status_code": "rewarded",
        "zip_code": null,
        "campaign_id": 1,
        "user_id": null,
        "participant_id": 1
    }
}

A user is created

{
    "user": {
        "id": 1,
        "name": "User 1",
        "email": "[email protected]",
        "email_verified_at": null,
        "created_at": "2022-09-16T04:59:31.000000Z",
        "updated_at": "2022-09-16T04:59:31.000000Z"
    }
}

A user is updated

{
    "user": {
        "old_value": {
            "id": 1,
            "name": "User 1",
            "email": "[email protected]",
            "email_verified_at": null,
            "created_at": "2022-09-16T04:59:31.000000Z",
            "updated_at": "2022-09-16T04:59:31.000000Z"
        },
        "new_value": {
            "id": 1,
            "name": "User 1 with update",
            "email": "[email protected]",
            "email_verified_at": null,
            "created_at": "2022-09-16T04:59:31.000000Z",
            "updated_at": "2022-09-16T05:41:31.000000Z"
        }
    }
}

A user is deleted

{
    "user": {
        "id": 1,
        "name": "User 1",
        "email": "[email protected]",
        "email_verified_at": null,
        "created_at": "2022-09-16T04:59:31.000000Z",
        "updated_at": "2022-09-16T04:59:31.000000Z"
    }
}

A campaign is created

{
    "campaign": {
        "id": 1,
        "name": "Campaign Name",
        "code": "",
        "slug": "campaign-name",
        "campaign_type": "instant_draw",
        "start_at": "2022-02-02T17:00:00.000000Z",
        "end_at": "2024-02-10T16:59:59.000000Z",
        "logo": null,
        "is_active": 1,
        "welcome_screen_before_campaign": null,
        "welcome_screen_during_campaign": null,
        "welcome_screen_after_campaign": null,
        "result_screen_win": null,
        "result_screen_not_win": null,
        "security_option": "unique_codes",
        "security_coupon_set_id": 13,
        "domains": null,
        "created_at": null,
        "updated_at": "2023-02-14T07:22:08.000000Z",
        "deleted_at": null,
        "use_webhook_for_rules": 1,
        "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
        "settings": {
            "limit_participants_win": "1"
        },
        "description": null,
        "use_leaderboard": 0
    }
}

A campaign is updated

{
    "campaign": {
        "old_value": {
            "id": 1,
            "name": "Campaign Name",
            "code": "",
            "slug": "campaign-name",
            "campaign_type": "instant_draw",
            "start_at": "2022-02-02T17:00:00.000000Z",
            "end_at": "2024-02-10T16:59:59.000000Z",
            "logo": null,
            "is_active": 1,
            "welcome_screen_before_campaign": null,
            "welcome_screen_during_campaign": null,
            "welcome_screen_after_campaign": null,
            "result_screen_win": null,
            "result_screen_not_win": null,
            "security_option": "unique_codes",
            "security_coupon_set_id": 13,
            "domains": null,
            "created_at": null,
            "updated_at": "2023-02-14T07:22:08.000000Z",
            "deleted_at": null,
            "use_webhook_for_rules": 1,
            "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
            "settings": {
                "limit_participants_win": "1"
            },
            "description": null,
            "use_leaderboard": 0
        },
        "new_value": {
            "id": 1,
            "name": "Campaign Name",
            "code": "",
            "slug": "campaign-name",
            "campaign_type": "instant_draw",
            "start_at": "2022-02-02T17:00:00.000000Z",
            "end_at": "2024-02-10T16:59:59.000000Z",
            "logo": null,
            "is_active": 1,
            "welcome_screen_before_campaign": null,
            "welcome_screen_during_campaign": null,
            "welcome_screen_after_campaign": null,
            "result_screen_win": null,
            "result_screen_not_win": null,
            "security_option": "unique_codes",
            "security_coupon_set_id": 13,
            "domains": null,
            "created_at": null,
            "updated_at": "2023-02-14T07:22:08.000000Z",
            "deleted_at": null,
            "use_webhook_for_rules": 1,
            "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
            "settings": {
                "limit_participants_win": "1"
            },
            "description": null,
            "use_leaderboard": 0
        }
    }
}

A campaign is deleted

{
    "campaign": {
        "id": 1,
        "name": "Campaign Name",
        "code": "",
        "slug": "campaign-name",
        "campaign_type": "instant_draw",
        "start_at": "2022-02-02T17:00:00.000000Z",
        "end_at": "2024-02-10T16:59:59.000000Z",
        "logo": null,
        "is_active": 1,
        "welcome_screen_before_campaign": null,
        "welcome_screen_during_campaign": null,
        "welcome_screen_after_campaign": null,
        "result_screen_win": null,
        "result_screen_not_win": null,
        "security_option": "unique_codes",
        "security_coupon_set_id": 13,
        "domains": null,
        "created_at": null,
        "updated_at": "2023-02-14T07:22:08.000000Z",
        "deleted_at": null,
        "use_webhook_for_rules": 1,
        "rules_webhook_url": "https:\/\/bin-request.dev.embrio.id\/magami",
        "settings": {
            "limit_participants_win": "1"
        },
        "description": null,
        "use_leaderboard": 0
    }
}

A coupon set is created

{
    "coupon_set": {
        "id": 1,
        "campaign_id": 1,
        "name": "This Coupons",
        "code": "This-coupons",
        "created_at": null,
        "updated_at": null,
        "is_active": 1,
        "is_set_point": 0,
        "description": null
    }
}

A coupon set is updated

{
    "coupon_set": {
        "old_value": {
            "id": 1,
            "campaign_id": 1,
            "name": "This Coupons",
            "code": "this-coupons",
            "created_at": null,
            "updated_at": null,
            "is_active": 1,
            "is_set_point": 0,
            "description": null
        },
        "new_value": {
            "id": 1,
            "campaign_id": 1,
            "name": "That Coupons",
            "code": "that-coupons",
            "created_at": null,
            "updated_at": null,
            "is_active": 1,
            "is_set_point": 0,
            "description": null
        }
    }
}

A coupon set is deleted

{
    "coupon_set": {
        "id": 1,
        "campaign_id": 1,
        "name": "This Coupons",
        "code": "this-coupons",
        "created_at": null,
        "updated_at": null,
        "is_active": 1,
        "is_set_point": 0,
        "description": null
    }
}

Coupon(s) has been generated

{
    "coupon_set": {
        "id": 1,
        "campaign_id": 1,
        "name": "This Coupons",
        "code": "this-coupons",
        "created_at": null,
        "updated_at": null,
        "is_active": 1,
        "is_set_point": 0,
        "description": null
    }
}

Coupon(s) has been imported

{
    "coupon_set": {
        "id": 1,
        "campaign_id": 1,
        "name": "This Coupons",
        "code": "this-coupons",
        "created_at": null,
        "updated_at": null,
        "is_active": 1,
        "is_set_point": 0,
        "description": null
    }
}

A coupon is updated

{
    "coupon": {
        "id": 1,
        "code": "ABCDEF",
        "created_at": null,
        "updated_at": null,
        "serial_number": null,
        "coupon_set_id": 1,
        "point": 0,
        "data": null
    }
}

A coupon is deleted

{
    "coupon": {
        "id": 1,
        "code": "ABCDEF",
        "created_at": null,
        "updated_at": null,
        "serial_number": null,
        "coupon_set_id": 1,
        "point": 0,
        "data": null
    }
}