v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBWebhooks
Creates a Webhook
post/Sites/{siteId}/Webhooks
Path parameters
siteIdinteger required
The site identifier
Request body
webhookEventTypes'None' | 'ScheduledOrderCreated' | 'ScheduledOrderUpdated' | 'ScheduledOrderDeleted' | 'ScheduledOrderPaused' | 'ScheduledOrderActivated' | 'PaymentMethodUpdated' | 'ScheduledOrderProcessed' | 'ScheduledOrderFailed' | 'ScheduledOrderItemCreated' | 'ScheduledOrderItemUpdated' | 'ScheduledOrderItemDeleted' | 'ScheduledOrderItemQuantityUpdated' | 'ScheduledOrderItemPriceUpdated' | 'ScheduledOrderItemSalePriceUpdated' | 'ScheduledOrderItemExpired' | 'ShippingRateCreated' | 'ShippingRateUpdated' | 'ShippingRateDeleted' | 'PaymentMethodDeleted' | 'BundleActivated' | 'BundleDeleted' | 'MembershipRuleCreated' | 'MembershipRuleUpdated' | 'MembershipRuleDeleted' | 'LoyaltySettingsCreated' | 'LoyaltySettingsUpdated' | 'LoyaltySettingsDeleted' | 'LoyaltyRedemptionCreated' | 'LoyaltyRedemptionConfirmed' | 'LoyaltyRedemptionRefunded' | 'ScheduledOrderSnoozed' | 'ScheduledOrderReactivated' required
targetUrlstring required
Response
Success
idinteger
siteIdinteger
createdUtcstring date-time
updatedUtcstring date-time
webhookEventTypes'None' | 'ScheduledOrderCreated' | 'ScheduledOrderUpdated' | 'ScheduledOrderDeleted' | 'ScheduledOrderPaused' | 'ScheduledOrderActivated' | 'PaymentMethodUpdated' | 'ScheduledOrderProcessed' | 'ScheduledOrderFailed' | 'ScheduledOrderItemCreated' | 'ScheduledOrderItemUpdated' | 'ScheduledOrderItemDeleted' | 'ScheduledOrderItemQuantityUpdated' | 'ScheduledOrderItemPriceUpdated' | 'ScheduledOrderItemSalePriceUpdated' | 'ScheduledOrderItemExpired' | 'ShippingRateCreated' | 'ShippingRateUpdated' | 'ShippingRateDeleted' | 'PaymentMethodDeleted' | 'BundleActivated' | 'BundleDeleted' | 'MembershipRuleCreated' | 'MembershipRuleUpdated' | 'MembershipRuleDeleted' | 'LoyaltySettingsCreated' | 'LoyaltySettingsUpdated' | 'LoyaltySettingsDeleted' | 'LoyaltyRedemptionCreated' | 'LoyaltyRedemptionConfirmed' | 'LoyaltyRedemptionRefunded' | 'ScheduledOrderSnoozed' | 'ScheduledOrderReactivated' required
targetUrlstring required