#Webhook events
GET /webhook-events
List every event name a webhook can subscribe to. Useful for building a subscription picker without hardcoding the list.
Requires the webhooks:read permission.
Request
curl \
"https://api.cascade.dev/webhook-events" \
-H "Authorization: Bearer sk_YOUR_SECRET_KEY"Request
import { client } from "@cascade-commerce/api/admin/client"
import { getWebhookEvents } from "@cascade-commerce/api/admin"
client.setConfig({
baseUrl: "https://api.cascade.dev",
headers: { Authorization: "Bearer sk_YOUR_SECRET_KEY" },
})
const { data, error } = await getWebhookEvents()Request
require "net/http"
uri = URI("https://api.cascade.dev/webhook-events")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer sk_YOUR_SECRET_KEY"
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.bodyRequest
import json
from urllib.request import Request, urlopen
req = Request(
"https://api.cascade.dev/webhook-events",
headers={"Authorization": "Bearer sk_YOUR_SECRET_KEY"},
)
with urlopen(req) as res:
print(json.load(res))Response
{
"data": ["customer.updated"]
}Response schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string",
"enum": [
"customer.updated",
"customer.deleted",
"customerTag.created",
"customerTag.updated",
"customerTag.deleted",
"order.updated",
"order.deleted",
"orderTag.created",
"orderTag.updated",
"orderTag.deleted",
"product.updated",
"product.deleted",
"productVariant.updated",
"productTag.created",
"productTag.updated",
"productTag.deleted",
"review.created",
"review.updated",
"review.deleted",
"productQuestion.created",
"productQuestion.updated",
"productQuestion.deleted",
"productQuestionAnswer.created",
"productQuestionAnswer.updated",
"productQuestionAnswer.deleted",
"site.created",
"site.updated",
"site.deleted",
"emailTemplate.created",
"emailTemplate.updated",
"emailTemplate.deleted",
"surveyFlow.created",
"surveyFlow.updated",
"surveyFlow.deleted",
"survey.deleted",
"loyaltyProgram.created",
"loyaltyProgram.updated",
"loyaltyProgram.deleted",
"loyaltyRule.created",
"loyaltyRule.updated",
"loyaltyRule.deleted",
"referral.updated",
"loyaltyTier.created",
"loyaltyTier.updated",
"loyaltyTier.deleted",
"loyaltyMembership.created",
"loyaltyMembership.tierChanged",
"loyaltyMembership.deleted",
"loyaltyTransaction.created",
"loyaltyReward.issued",
"loyaltyReward.redeemed",
"loyaltyReward.revoked",
"loyaltyReward.expired",
"loyaltyReward.expiringSoon",
"loyaltyPoints.expiringSoon",
"stampCard.created",
"stampCard.updated",
"stampCard.completed",
"quickFilter.created",
"quickFilter.updated",
"quickFilter.deleted",
"wishlist.created",
"wishlist.updated",
"wishlist.deleted",
"webhook.created",
"webhook.updated",
"webhook.deleted"
],
"description": "A webhook event name, in `resource.action` form."
},
"description": "Every available event name."
}
},
"required": ["data"],
"additionalProperties": false
}