Notifications

Get Notification Settings

Changed on

Retrieves the notification settings and channel subscriptions.

get/v1/shops/{shopId}/notifications/settings

Request

Response

idstring
namestring
descriptionstring

Example response

[
  {
    "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": "ShopInvoiceLatePayment",
    "name": "Late Payment Received",
    "description": "Get notified when money arrives for an order that already expired, was cancelled, was paid another way, or was switched to another payment method.",
    "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": "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": "ShopPaymentDisputeOpened",
    "name": "Payment Dispute Opened",
    "description": "Get notified when a buyer disputes a payment or a dispute needs a new response.",
    "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": "ShopPaymentDisputeClosed",
    "name": "Payment Dispute Closed",
    "description": "Get notified when a payment dispute is won, lost or closed.",
    "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
      }
    ]
  }
]

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status