Get Notification Settings
curl --request GET \
--url https://api.sellauth.com/v1/shops/{shopId}/notifications/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sellauth.com/v1/shops/{shopId}/notifications/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sellauth.com/v1/shops/{shopId}/notifications/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sellauth.com/v1/shops/{shopId}/notifications/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sellauth.com/v1/shops/{shopId}/notifications/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sellauth.com/v1/shops/{shopId}/notifications/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sellauth.com/v1/shops/{shopId}/notifications/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "ShopInvoiceCreated",
"name": "Checkout Started",
"description": "Get notified when a customer starts checkout, before payment.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceProcessed",
"name": "New Sale",
"description": "Get notified when an order is paid and delivered.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceConfirming",
"name": "Order Marked as Paid",
"description": "Get notified when a customer marks a custom payment method order as paid and it needs your confirmation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceOutOfStock",
"name": "Paid Order Missing Stock",
"description": "Get notified when a paid order has items that could not be delivered due to missing stock.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductOutOfStock",
"name": "Product Sold Out",
"description": "Get notified when a product or variant runs out of stock.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackReceived",
"name": "New Feedback",
"description": "Get notified when a customer leaves feedback on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackUpdated",
"name": "Feedback Edited",
"description": "Get notified when a customer edits their feedback on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackDisputeAccepted",
"name": "Feedback Dispute Accepted",
"description": "Get notified when a feedback dispute is accepted.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackDisputeRejected",
"name": "Feedback Dispute Rejected",
"description": "Get notified when a feedback dispute is rejected.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopTicketCreated",
"name": "New Support Ticket",
"description": "Get notified when a new support ticket is created.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopTicketMessage",
"name": "New Ticket Reply",
"description": "Get notified when a new reply is posted in a support ticket.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopSubscriptionEnding",
"name": "SellAuth Plan Expiring",
"description": "Get notified when your SellAuth plan is about to expire.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": false,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionStarted",
"name": "New Customer Subscription",
"description": "Get notified when a customer starts a product subscription.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionEnded",
"name": "Customer Subscription Ended",
"description": "Get notified when a product subscription is cancelled or expires. Use the webhook to revoke any access you granted.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionRenewalFailed",
"name": "Customer Subscription Payment Failed",
"description": "Get notified when a subscription renewal payment fails or is overdue (the subscription is past due, not yet ended).",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopError",
"name": "Shop Error",
"description": "Get notified when an error occurs on the shop.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductRestocked",
"name": "Product Restocked",
"description": "Get notified when a product or variant is restocked.",
"channels": [
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceWithdrawalRequested",
"name": "Withdrawal Requested",
"description": "Get notified when a customer requests a withdrawal on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceCustomFieldsSubmitted",
"name": "Custom Fields Submitted",
"description": "Get notified when a customer fills in custom fields after paying.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopAffiliatePayoutRequested",
"name": "Affiliate Payout Requested",
"description": "Get notified when an affiliate requests a payout of their affiliate balance.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerApplicationReceived",
"name": "Reseller Application Received",
"description": "Get notified when a customer applies to become a reseller.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceApplicationReceived",
"name": "Marketplace Access Request Received",
"description": "Get notified when someone requests reseller access through your marketplace listing.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingApproved",
"name": "Marketplace Listing Approved",
"description": "Get notified when your reseller marketplace listing (or an update to it) is approved.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingRejected",
"name": "Marketplace Listing Rejected",
"description": "Get notified when your reseller marketplace listing (or an update to it) is rejected.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingRemoved",
"name": "Marketplace Listing Removed",
"description": "Get notified when your reseller marketplace listing is removed by moderation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceImportRemoved",
"name": "Imported Product Removed",
"description": "Get notified when a product you imported from the reseller marketplace is removed by moderation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
}
]Notifications
Get Notification Settings
Retrieves the notification settings and channel subscriptions.
GET
/
v1
/
shops
/
{shopId}
/
notifications
/
settings
Get Notification Settings
curl --request GET \
--url https://api.sellauth.com/v1/shops/{shopId}/notifications/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sellauth.com/v1/shops/{shopId}/notifications/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sellauth.com/v1/shops/{shopId}/notifications/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sellauth.com/v1/shops/{shopId}/notifications/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sellauth.com/v1/shops/{shopId}/notifications/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sellauth.com/v1/shops/{shopId}/notifications/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sellauth.com/v1/shops/{shopId}/notifications/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "ShopInvoiceCreated",
"name": "Checkout Started",
"description": "Get notified when a customer starts checkout, before payment.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceProcessed",
"name": "New Sale",
"description": "Get notified when an order is paid and delivered.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceConfirming",
"name": "Order Marked as Paid",
"description": "Get notified when a customer marks a custom payment method order as paid and it needs your confirmation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceOutOfStock",
"name": "Paid Order Missing Stock",
"description": "Get notified when a paid order has items that could not be delivered due to missing stock.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductOutOfStock",
"name": "Product Sold Out",
"description": "Get notified when a product or variant runs out of stock.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackReceived",
"name": "New Feedback",
"description": "Get notified when a customer leaves feedback on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackUpdated",
"name": "Feedback Edited",
"description": "Get notified when a customer edits their feedback on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackDisputeAccepted",
"name": "Feedback Dispute Accepted",
"description": "Get notified when a feedback dispute is accepted.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackDisputeRejected",
"name": "Feedback Dispute Rejected",
"description": "Get notified when a feedback dispute is rejected.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopTicketCreated",
"name": "New Support Ticket",
"description": "Get notified when a new support ticket is created.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopTicketMessage",
"name": "New Ticket Reply",
"description": "Get notified when a new reply is posted in a support ticket.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopSubscriptionEnding",
"name": "SellAuth Plan Expiring",
"description": "Get notified when your SellAuth plan is about to expire.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": false,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionStarted",
"name": "New Customer Subscription",
"description": "Get notified when a customer starts a product subscription.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionEnded",
"name": "Customer Subscription Ended",
"description": "Get notified when a product subscription is cancelled or expires. Use the webhook to revoke any access you granted.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionRenewalFailed",
"name": "Customer Subscription Payment Failed",
"description": "Get notified when a subscription renewal payment fails or is overdue (the subscription is past due, not yet ended).",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopError",
"name": "Shop Error",
"description": "Get notified when an error occurs on the shop.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductRestocked",
"name": "Product Restocked",
"description": "Get notified when a product or variant is restocked.",
"channels": [
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceWithdrawalRequested",
"name": "Withdrawal Requested",
"description": "Get notified when a customer requests a withdrawal on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceCustomFieldsSubmitted",
"name": "Custom Fields Submitted",
"description": "Get notified when a customer fills in custom fields after paying.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopAffiliatePayoutRequested",
"name": "Affiliate Payout Requested",
"description": "Get notified when an affiliate requests a payout of their affiliate balance.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerApplicationReceived",
"name": "Reseller Application Received",
"description": "Get notified when a customer applies to become a reseller.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceApplicationReceived",
"name": "Marketplace Access Request Received",
"description": "Get notified when someone requests reseller access through your marketplace listing.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingApproved",
"name": "Marketplace Listing Approved",
"description": "Get notified when your reseller marketplace listing (or an update to it) is approved.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingRejected",
"name": "Marketplace Listing Rejected",
"description": "Get notified when your reseller marketplace listing (or an update to it) is rejected.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingRemoved",
"name": "Marketplace Listing Removed",
"description": "Get notified when your reseller marketplace listing is removed by moderation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceImportRemoved",
"name": "Imported Product Removed",
"description": "Get notified when a product you imported from the reseller marketplace is removed by moderation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
}
]Authorizations
You can retrieve your API key from your dashboard under Account > Developers.
Path Parameters
The ID of the shop.
Response
200 - application/json
Example:
[
{
"id": "ShopInvoiceCreated",
"name": "Checkout Started",
"description": "Get notified when a customer starts checkout, before payment.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceProcessed",
"name": "New Sale",
"description": "Get notified when an order is paid and delivered.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceConfirming",
"name": "Order Marked as Paid",
"description": "Get notified when a customer marks a custom payment method order as paid and it needs your confirmation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceOutOfStock",
"name": "Paid Order Missing Stock",
"description": "Get notified when a paid order has items that could not be delivered due to missing stock.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductOutOfStock",
"name": "Product Sold Out",
"description": "Get notified when a product or variant runs out of stock.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackReceived",
"name": "New Feedback",
"description": "Get notified when a customer leaves feedback on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackUpdated",
"name": "Feedback Edited",
"description": "Get notified when a customer edits their feedback on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackDisputeAccepted",
"name": "Feedback Dispute Accepted",
"description": "Get notified when a feedback dispute is accepted.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopFeedbackDisputeRejected",
"name": "Feedback Dispute Rejected",
"description": "Get notified when a feedback dispute is rejected.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopTicketCreated",
"name": "New Support Ticket",
"description": "Get notified when a new support ticket is created.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopTicketMessage",
"name": "New Ticket Reply",
"description": "Get notified when a new reply is posted in a support ticket.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopSubscriptionEnding",
"name": "SellAuth Plan Expiring",
"description": "Get notified when your SellAuth plan is about to expire.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": false,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionStarted",
"name": "New Customer Subscription",
"description": "Get notified when a customer starts a product subscription.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionEnded",
"name": "Customer Subscription Ended",
"description": "Get notified when a product subscription is cancelled or expires. Use the webhook to revoke any access you granted.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductSubscriptionRenewalFailed",
"name": "Customer Subscription Payment Failed",
"description": "Get notified when a subscription renewal payment fails or is overdue (the subscription is past due, not yet ended).",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopError",
"name": "Shop Error",
"description": "Get notified when an error occurs on the shop.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopProductRestocked",
"name": "Product Restocked",
"description": "Get notified when a product or variant is restocked.",
"channels": [
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceWithdrawalRequested",
"name": "Withdrawal Requested",
"description": "Get notified when a customer requests a withdrawal on an order.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopInvoiceCustomFieldsSubmitted",
"name": "Custom Fields Submitted",
"description": "Get notified when a customer fills in custom fields after paying.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopAffiliatePayoutRequested",
"name": "Affiliate Payout Requested",
"description": "Get notified when an affiliate requests a payout of their affiliate balance.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerApplicationReceived",
"name": "Reseller Application Received",
"description": "Get notified when a customer applies to become a reseller.",
"channels": [
{
"name": "mail",
"subscribed": true,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceApplicationReceived",
"name": "Marketplace Access Request Received",
"description": "Get notified when someone requests reseller access through your marketplace listing.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingApproved",
"name": "Marketplace Listing Approved",
"description": "Get notified when your reseller marketplace listing (or an update to it) is approved.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingRejected",
"name": "Marketplace Listing Rejected",
"description": "Get notified when your reseller marketplace listing (or an update to it) is rejected.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceListingRemoved",
"name": "Marketplace Listing Removed",
"description": "Get notified when your reseller marketplace listing is removed by moderation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
},
{
"id": "ShopResellerMarketplaceImportRemoved",
"name": "Imported Product Removed",
"description": "Get notified when a product you imported from the reseller marketplace is removed by moderation.",
"channels": [
{
"name": "mail",
"subscribed": false,
"parameters": null
},
{
"name": "discord",
"subscribed": false,
"parameters": null,
"customizable_embed": true,
"embed_customized": false
},
{
"name": "telegram",
"subscribed": false,
"parameters": null
},
{
"name": "webhook",
"subscribed": false,
"parameters": null
}
]
}
]