Notifications

Get Notification Settings

Retrieves the notification settings and channel subscriptions.

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

Response

object[] required

Example response

[
  {
    "id": "ShopInvoiceCreated",
    "name": "Order Created",
    "description": "Get notified when a new order is created.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopInvoiceProcessed",
    "name": "Order Completed",
    "description": "Get notified when an invoice has been processed.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopInvoiceConfirming",
    "name": "Manual Order Marked As Paid",
    "description": "Get notified when an invoice gets marked as Confirming.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopInvoiceOutOfStock",
    "name": "Invoice Items Out of Stock",
    "description": "Get notified when a product runs out of stock after a sale.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopProductOutOfStock",
    "name": "Product Variant Out of Stock",
    "description": "Get notified when a product variant runs out of stock.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopFeedbackReceived",
    "name": "Feedback Created",
    "description": "Get notified when a order feedback is submitted.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopFeedbackUpdated",
    "name": "Feedback Updated",
    "description": "Get notified when a order feedback is edited.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "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
      },
      {
        "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
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopTicketCreated",
    "name": "Ticket Created",
    "description": "Get notified when a new support ticket is created.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopTicketMessage",
    "name": "Ticket Message",
    "description": "Get notified when a new support ticket message is sent.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopSubscriptionEnding",
    "name": "Shop Subscription Ending",
    "description": "Get notified when the subscription plan is expiring.",
    "channels": [
      {
        "name": "mail",
        "subscribed": true,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopPlanChanged",
    "name": "Shop Plan Changed",
    "description": "Get notified when your shop subscription plan changes.",
    "channels": [
      {
        "name": "mail",
        "subscribed": true,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopProductSubscriptionStarted",
    "name": "New Subscriber",
    "description": "Get notified when a customer starts a product subscription.",
    "channels": [
      {
        "name": "mail",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopProductSubscriptionEnded",
    "name": "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
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopProductSubscriptionRenewalFailed",
    "name": "Subscription Renewal 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
      },
      {
        "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
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  },
  {
    "id": "ShopProductRestocked",
    "name": "Product Restocked",
    "description": "Send a message when a variant is restocked from zero stock.",
    "channels": [
      {
        "name": "discord",
        "subscribed": false,
        "parameters": null
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "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
      },
      {
        "name": "telegram",
        "subscribed": false,
        "parameters": null
      },
      {
        "name": "webhook",
        "subscribed": false,
        "parameters": null
      }
    ]
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.