Webhook Notifications
Webhooks allow you to send data to external endpoints when an event within your webstore is triggered.
Webhooks are a premium feature. To list, create, update or delete webhooks you must be subscribed to its associated plan. You can view plans at https://admin.enderpay.com/dashboard/plans
- 1.Using the sidebar, navigate to Integrations > Webhooks
- 2.Click on the Create button.
- 3.Complete the form and click the Create button.
- 1.Using the sidebar, navigate to Integrations > Webhooks
- 2.Click on the edit icon next to the webhook you wish to modify
- 3.Make the necessary changes to your webhook and click the Update button when complete.
Name: This is the webhook name, it helps you identify the webhook.
Notification Event: This is the webhook notification event. It is the event that triggers the webhook to send.
Description: This is the webhook description, it helps you identify the webhook and is not required.
Webhook URL: This is the webhook URL. The webhook URL is where information that is triggered by the notification event gets sent to.
This event is triggered when a customer attempts to log into your store but is banned.
{
"event": "STORE_LOGIN_PLAYER_BANNED",
"data": {
"ban": {
"reason": "adawd"
},
"customer": {
"username": "Test",
"uuid": "d8d5a9237b2043d8883b1150148d6955",
"dashed_uuid": "d8d5a923-7b20-43d8-883b-1150148d6955"
}
}
}
This event is triggered when a customer successfully logs into your store.
{
"event": "STORE_LOGIN_SUCCESSFUL",
"data": {
"customer": {
"username": "Enderpay",
"uuid": "2bd7c37d69ff4589ac80ac8ac9bb661b",
"dashed_uuid": "2bd7c37d-69ff-4589-ac80-ac8ac9bb661b"
}
}
}
This event is triggered when a package is charged back.
{
"event": "STORE_PACKAGE_CHARGEBACK",
"data": {
"payment": {
"total": "100.00",
"gateway_type": "STRIPE",
"ip_address": "127.0.0.1"
},
"customer": {
"username": "Zioty",
"uuid": "e278d8b033884b49b7d55e79623fce7a",
"dashed_uuid": "e278d8b0-3388-4b49-b7d5-5e79623fce7a"
},
"package": {
"name": "Test",
"quantity": 1
}
}
}
This event is triggered when a package expires.
{
"event": "STORE_PACKAGE_EXPIRY",
"data": {
"payment": {
"total": "55.00",
"gateway_type": "STRIPE",
"ip_address": "127.0.0.1"
},
"customer": {
"username": "Zioty",
"uuid": "e278d8b033884b49b7d55e79623fce7a",
"dashed_uuid": "e278d8b0-3388-4b49-b7d5-5e79623fce7a"
},
"package": {
"name": "Test",
"quantity": 1
}
}
}
This event is triggered when a package is purchased.
{
"event": "STORE_PACKAGE_INITIAL",
"data": {
"payment": {
"total": "100.00",
"gateway_type": "STRIPE",
"ip_address": "127.0.0.1"
},
"customer": {
"username": "Zioty",
"uuid": "e278d8b033884b49b7d55e79623fce7a",
"dashed_uuid": "e278d8b0-3388-4b49-b7d5-5e79623fce7a"
},
"package": {
"name": "Test",
"quantity": 1
}
}
}
This event is triggered when a package is renewed.
{
"event": "STORE_PACKAGE_RENEWAL",
"data": {
"payment": {
"total": "100.00",
"gateway_type": "STRIPE",
"ip_address": "127.0.0.1"
},
"customer": {
"username": "Zioty",
"uuid": "e278d8b033884b49b7d55e79623fce7a",
"dashed_uuid": "e278d8b0-3388-4b49-b7d5-5e79623fce7a"
},
"package": {
"name": "Test",
"quantity": 1
}
}
}
This event is triggered when a payment milestone reward is achieved.
{
"event": "REWARD_GIVEN_PAYMENT_MILESTONE",
"data": {
"reward": {
"id": 16,
"name": "$100 GBP Donated!"
},
"customer": {
"uuid": "e409edfebd9d4e6ea7ebd194329ad51a",
"dashed_uuid": "e409edfe-bd9d-4e6e-a7eb-d194329ad51a",
"username": "Madci"
}
}
}
This event is triggered when a return customer reward is achieved.
{
"event": "REWARD_GIVEN_RETURN_CUSTOMER",
"data": {
"reward": {
"id": 17,
"name": "Return Customer"
},
"customer": {
"uuid": "e409edfebd9d4e6ea7ebd194329ad51a",
"dashed_uuid": "e409edfe-bd9d-4e6e-a7eb-d194329ad51a",
"username": "Madci"
}
}
}
This event is triggered when a reward count reward is achieved.
{
"event": "REWARD_GIVEN_REWARD_COUNT",
"data": {
"reward": {
"id": 18,
"name": "Earn 10 Rewards!"
},
"customer": {
"uuid": "e409edfebd9d4e6ea7ebd194329ad51a",
"dashed_uuid": "e409edfe-bd9d-4e6e-a7eb-d194329ad51a",
"username": "Madci"
}
}
}
Last modified 10mo ago