latestOpenAPI 3.0.02026-08-10134271194.2 KB
da24e062ff11
Webhooks
Edit existing webhook
put/vendor/webhook/{webhookId}
Path parameters
webhookIdstring required
Request body
eventType'SUBSCRIPTION_CREATE' | 'SUBSCRIPTION_ACTIVATE' | 'SUBSCRIPTION_CANCEL' | 'SUBSCRIPTION_LINE_UPDATE' | 'SUBSCRIPTION_ITEM_OUT_OF_STOCK' | 'SUBSCRIPTION_PRODUCT_UNAVAILABLE' | 'SUBSCRIPTION_PAUSE' | 'SUBSCRIPTION_AUTO_RESUME' | 'SUBSCRIPTION_SKIP' | 'SUBSCRIPTION_UNSKIP' | 'SUBSCRIPTION_GIFT' | 'SUBSCRIPTION_SET_NEXT_DATE' | 'SUBSCRIPTION_SEND_NOW' | 'SUBSCRIPTION_UPCOMING_ORDER' | 'SUBSCRIPTION_FAILED_PAYMENT' | 'SUBSCRIPTION_SUCCESSFUL_PAYMENT' | 'PAYMENT_METHOD_UPDATE' | 'PAYMENT_EXPIRED_NOTIFICATION' | 'BUNDLE_COMPLETE' | 'CUSTOMER_OTP_AUTH_CREATED' | 'CUSTOMER_MAGIC_LINK_AUTH_CREATED' | 'LOYALTY_POINTS_EARNED' | 'REFERRAL_CODE_GENERATED' | 'LOYALTY_BONUS_EARNED' | 'LOYALTY_POINTS_REDEEMED' | 'LOYALTY_TIER_ADVANCEMENT' | 'LOYALTY_TIER_DOWNGRADE' | 'SUCCESSFUL_REFERRAL' | 'SUBSCRIPTION_AUTO_CANCEL' required
urlstring required
Response
Successful response
eventType'SUBSCRIPTION_CREATE' | 'SUBSCRIPTION_ACTIVATE' | 'SUBSCRIPTION_CANCEL' | 'SUBSCRIPTION_LINE_UPDATE' | 'SUBSCRIPTION_ITEM_OUT_OF_STOCK' | 'SUBSCRIPTION_PRODUCT_UNAVAILABLE' | 'SUBSCRIPTION_PAUSE' | 'SUBSCRIPTION_AUTO_RESUME' | 'SUBSCRIPTION_SKIP' | 'SUBSCRIPTION_UNSKIP' | 'SUBSCRIPTION_GIFT' | 'SUBSCRIPTION_SET_NEXT_DATE' | 'SUBSCRIPTION_SEND_NOW' | 'SUBSCRIPTION_UPCOMING_ORDER' | 'SUBSCRIPTION_FAILED_PAYMENT' | 'SUBSCRIPTION_SUCCESSFUL_PAYMENT' | 'PAYMENT_METHOD_UPDATE' | 'PAYMENT_EXPIRED_NOTIFICATION' | 'BUNDLE_COMPLETE' | 'CUSTOMER_OTP_AUTH_CREATED' | 'CUSTOMER_MAGIC_LINK_AUTH_CREATED' | 'LOYALTY_POINTS_EARNED' | 'REFERRAL_CODE_GENERATED' | 'LOYALTY_BONUS_EARNED' | 'LOYALTY_POINTS_REDEEMED' | 'LOYALTY_TIER_ADVANCEMENT' | 'LOYALTY_TIER_DOWNGRADE' | 'SUCCESSFUL_REFERRAL' | 'SUBSCRIPTION_AUTO_CANCEL' required
urlstring required
idstring required
createdDatestring required
A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
updatedDatestring required
A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
deletedAtstring
A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ