739 lines
24 KiB
JSON
739 lines
24 KiB
JSON
[
|
|
{
|
|
"name": "cart.created",
|
|
"parentName": "CartWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the cart\n}\n```",
|
|
"description": "Emitted when a cart is created.",
|
|
"workflows": [
|
|
"createCartWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "cart.updated",
|
|
"parentName": "CartWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the cart\n}\n```",
|
|
"description": "Emitted when a cart's details are updated.",
|
|
"workflows": [
|
|
"updateLineItemInCartWorkflow",
|
|
"updateCartWorkflow",
|
|
"addToCartWorkflow",
|
|
"addShippingMethodToCartWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "cart.region_updated",
|
|
"parentName": "CartWorkflowEvents",
|
|
"propertyName": "REGION_UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the cart\n}\n```",
|
|
"description": "Emitted when the cart's region is updated. This\nevent is emitted alongside the `cart.updated` event.",
|
|
"workflows": [
|
|
"updateCartWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "cart.customer_transferred",
|
|
"parentName": "CartWorkflowEvents",
|
|
"propertyName": "CUSTOMER_TRANSFERRED",
|
|
"payload": "```ts\n{\n id, // The ID of the cart\n customer_id, // The ID of the customer\n}\n```",
|
|
"description": "Emitted when the customer in the cart is transferred.",
|
|
"workflows": [
|
|
"transferCartCustomerWorkflow"
|
|
],
|
|
"since": "2.8.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "customer.created",
|
|
"parentName": "CustomerWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the customer\n}\n```",
|
|
"description": "Emitted when a customer is created.",
|
|
"workflows": [
|
|
"createCustomersWorkflow",
|
|
"createCustomerAccountWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "customer.updated",
|
|
"parentName": "CustomerWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the customer\n}\n```",
|
|
"description": "Emitted when a customer is updated.",
|
|
"workflows": [
|
|
"updateCustomersWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "customer.deleted",
|
|
"parentName": "CustomerWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the customer\n}\n```",
|
|
"description": "Emitted when a customer is deleted.",
|
|
"workflows": [
|
|
"deleteCustomersWorkflow",
|
|
"removeCustomerAccountWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.updated",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
|
|
"description": "Emitted when the details of an order or draft order is updated. This\ndoesn't include updates made by an edit.",
|
|
"workflows": [
|
|
"updateOrderWorkflow",
|
|
"updateDraftOrderWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.placed",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "PLACED",
|
|
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
|
|
"description": "Emitted when an order is placed, or when a draft order is converted to an\norder.",
|
|
"workflows": [
|
|
"convertDraftOrderWorkflow",
|
|
"completeCartWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.canceled",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "CANCELED",
|
|
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
|
|
"description": "Emitted when an order is canceld.",
|
|
"workflows": [
|
|
"cancelOrderWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.completed",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "COMPLETED",
|
|
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
|
|
"description": "Emitted when orders are completed.",
|
|
"workflows": [
|
|
"completeOrderWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.archived",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "ARCHIVED",
|
|
"payload": "```ts\n{\n id, // The ID of the order\n}\n```",
|
|
"description": "Emitted when an order is archived.",
|
|
"workflows": [
|
|
"archiveOrderWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.fulfillment_created",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "FULFILLMENT_CREATED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n fulfillment_id, // The ID of the fulfillment\n no_notification, // (boolean) Whether to notify the customer\n}\n```",
|
|
"description": "Emitted when a fulfillment is created for an order.",
|
|
"workflows": [
|
|
"createOrderFulfillmentWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.fulfillment_canceled",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "FULFILLMENT_CANCELED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n fulfillment_id, // The ID of the fulfillment\n no_notification, // (boolean) Whether to notify the customer\n}\n```",
|
|
"description": "Emitted when an order's fulfillment is canceled.",
|
|
"workflows": [
|
|
"cancelOrderFulfillmentWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.return_requested",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "RETURN_REQUESTED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n return_id, // The ID of the return\n}\n```",
|
|
"description": "Emitted when a return request is confirmed.",
|
|
"workflows": [
|
|
"createAndCompleteReturnOrderWorkflow",
|
|
"confirmReturnRequestWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.return_received",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "RETURN_RECEIVED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n return_id, // The ID of the return\n}\n```",
|
|
"description": "Emitted when a return is marked as received.",
|
|
"workflows": [
|
|
"createAndCompleteReturnOrderWorkflow",
|
|
"confirmReturnReceiveWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.claim_created",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "CLAIM_CREATED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n claim_id, // The ID of the claim\n}\n```",
|
|
"description": "Emitted when a claim is created for an order.",
|
|
"workflows": [
|
|
"confirmClaimRequestWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.exchange_created",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "EXCHANGE_CREATED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n exchange_id, // The ID of the exchange\n}\n```",
|
|
"description": "Emitted when an exchange is created for an order.",
|
|
"workflows": [
|
|
"confirmExchangeRequestWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order.transfer_requested",
|
|
"parentName": "OrderWorkflowEvents",
|
|
"propertyName": "TRANSFER_REQUESTED",
|
|
"payload": "```ts\n{\n id, // The ID of the order\n order_change_id, // The ID of the order change created for the transfer\n}\n```",
|
|
"description": "Emitted when an order is requested to be transferred to\nanother customer.",
|
|
"workflows": [
|
|
"requestOrderTransferWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order-edit.requested",
|
|
"parentName": "OrderEditWorkflowEvents",
|
|
"propertyName": "REQUESTED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n}\n```",
|
|
"description": "Emitted when an order edit is requested.",
|
|
"workflows": [
|
|
"requestOrderEditRequestWorkflow"
|
|
],
|
|
"since": "2.8.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order-edit.confirmed",
|
|
"parentName": "OrderEditWorkflowEvents",
|
|
"propertyName": "CONFIRMED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n}\n```",
|
|
"description": "Emitted when an order edit request is confirmed.",
|
|
"workflows": [
|
|
"confirmOrderEditRequestWorkflow"
|
|
],
|
|
"since": "2.8.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "order-edit.canceled",
|
|
"parentName": "OrderEditWorkflowEvents",
|
|
"propertyName": "CANCELED",
|
|
"payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n}\n```",
|
|
"description": "Emitted when an order edit request is canceled.",
|
|
"workflows": [
|
|
"cancelBeginOrderEditWorkflow"
|
|
],
|
|
"since": "2.8.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "user.created",
|
|
"parentName": "UserWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the user\n}\n```",
|
|
"description": "Emitted when users are created.",
|
|
"workflows": [
|
|
"createUsersWorkflow",
|
|
"createUserAccountWorkflow",
|
|
"acceptInviteWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "user.updated",
|
|
"parentName": "UserWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the user\n}\n```",
|
|
"description": "Emitted when users are updated.",
|
|
"workflows": [
|
|
"updateUsersWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "user.deleted",
|
|
"parentName": "UserWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the user\n}\n```",
|
|
"description": "Emitted when users are deleted.",
|
|
"workflows": [
|
|
"deleteUsersWorkflow",
|
|
"removeUserAccountWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "auth.password_reset",
|
|
"parentName": "AuthWorkflowEvents",
|
|
"propertyName": "PASSWORD_RESET",
|
|
"payload": "```ts\n{\n entity_id, // The identifier of the user or customer. For example, an email address.\n actor_type, // The type of actor. For example, \"customer\", \"user\", or custom.\n token, // The generated token.\n}\n```",
|
|
"description": "Emitted when a reset password token is generated. You can listen to this event\nto send a reset password email to the user or customer, for example.",
|
|
"workflows": [
|
|
"generateResetPasswordTokenWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "sales-channel.created",
|
|
"parentName": "SalesChannelWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the sales channel\n}\n```",
|
|
"description": "Emitted when sales channels are created.",
|
|
"workflows": [
|
|
"createSalesChannelsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "sales-channel.updated",
|
|
"parentName": "SalesChannelWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the sales channel\n}\n```",
|
|
"description": "Emitted when sales channels are updated.",
|
|
"workflows": [
|
|
"updateSalesChannelsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "sales-channel.deleted",
|
|
"parentName": "SalesChannelWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the sales channel\n}\n```",
|
|
"description": "Emitted when sales channels are deleted.",
|
|
"workflows": [
|
|
"deleteSalesChannelsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-category.created",
|
|
"parentName": "ProductCategoryWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product category\n}\n```",
|
|
"description": "Emitted when product categories are created.",
|
|
"workflows": [
|
|
"createProductCategoriesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-category.updated",
|
|
"parentName": "ProductCategoryWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product category\n}\n```",
|
|
"description": "Emitted when product categories are updated.",
|
|
"workflows": [
|
|
"updateProductCategoriesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-category.deleted",
|
|
"parentName": "ProductCategoryWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product category\n}\n```",
|
|
"description": "Emitted when product categories are deleted.",
|
|
"workflows": [
|
|
"deleteProductCategoriesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-collection.created",
|
|
"parentName": "ProductCollectionWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product collection\n}\n```",
|
|
"description": "Emitted when product collections are created.",
|
|
"workflows": [
|
|
"createCollectionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-collection.updated",
|
|
"parentName": "ProductCollectionWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product collection\n}\n```",
|
|
"description": "Emitted when product collections are updated.",
|
|
"workflows": [
|
|
"updateCollectionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-collection.deleted",
|
|
"parentName": "ProductCollectionWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product collection\n}\n```",
|
|
"description": "Emitted when product collections are deleted.",
|
|
"workflows": [
|
|
"deleteCollectionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-variant.updated",
|
|
"parentName": "ProductVariantWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product variant\n}\n```",
|
|
"description": "Emitted when product variants are updated.",
|
|
"workflows": [
|
|
"updateProductVariantsWorkflow",
|
|
"batchProductVariantsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-variant.created",
|
|
"parentName": "ProductVariantWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product variant\n}\n```",
|
|
"description": "Emitted when product variants are created.",
|
|
"workflows": [
|
|
"createProductVariantsWorkflow",
|
|
"createProductsWorkflow",
|
|
"batchProductVariantsWorkflow",
|
|
"batchProductsWorkflow",
|
|
"importProductsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-variant.deleted",
|
|
"parentName": "ProductVariantWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product variant\n}\n```",
|
|
"description": "Emitted when product variants are deleted.",
|
|
"workflows": [
|
|
"deleteProductVariantsWorkflow",
|
|
"batchProductVariantsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product.updated",
|
|
"parentName": "ProductWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product\n}\n```",
|
|
"description": "Emitted when products are updated.",
|
|
"workflows": [
|
|
"updateProductsWorkflow",
|
|
"batchProductsWorkflow",
|
|
"importProductsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product.created",
|
|
"parentName": "ProductWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product\n}\n```",
|
|
"description": "Emitted when products are created.",
|
|
"workflows": [
|
|
"createProductsWorkflow",
|
|
"batchProductsWorkflow",
|
|
"importProductsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product.deleted",
|
|
"parentName": "ProductWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product\n}\n```",
|
|
"description": "Emitted when products are deleted.",
|
|
"workflows": [
|
|
"deleteProductsWorkflow",
|
|
"batchProductsWorkflow",
|
|
"importProductsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-type.updated",
|
|
"parentName": "ProductTypeWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product type\n}\n```",
|
|
"description": "Emitted when product types are updated.",
|
|
"workflows": [
|
|
"updateProductTypesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-type.created",
|
|
"parentName": "ProductTypeWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product type\n}\n```",
|
|
"description": "Emitted when product types are created.",
|
|
"workflows": [
|
|
"createProductTypesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-type.deleted",
|
|
"parentName": "ProductTypeWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product type\n}\n```",
|
|
"description": "Emitted when product types are deleted.",
|
|
"workflows": [
|
|
"deleteProductTypesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-tag.updated",
|
|
"parentName": "ProductTagWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product tag\n}\n```",
|
|
"description": "Emitted when product tags are updated.",
|
|
"workflows": [
|
|
"updateProductTagsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-tag.created",
|
|
"parentName": "ProductTagWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product tag\n}\n```",
|
|
"description": "Emitted when product tags are created.",
|
|
"workflows": [
|
|
"createProductTagsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-tag.deleted",
|
|
"parentName": "ProductTagWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product tag\n}\n```",
|
|
"description": "Emitted when product tags are deleted.",
|
|
"workflows": [
|
|
"deleteProductTagsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-option.updated",
|
|
"parentName": "ProductOptionWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product option\n}\n```",
|
|
"description": "Emitted when product options are updated.",
|
|
"workflows": [
|
|
"updateProductOptionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-option.created",
|
|
"parentName": "ProductOptionWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the product option\n}\n```",
|
|
"description": "Emitted when product options are created.",
|
|
"workflows": [
|
|
"createProductOptionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "product-option.deleted",
|
|
"parentName": "ProductOptionWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the product option\n}\n```",
|
|
"description": "Emitted when product options are deleted.",
|
|
"workflows": [
|
|
"deleteProductOptionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "invite.accepted",
|
|
"parentName": "InviteWorkflowEvents",
|
|
"propertyName": "ACCEPTED",
|
|
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
|
|
"description": "Emitted when an invite is accepted.",
|
|
"workflows": [
|
|
"acceptInviteWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "invite.created",
|
|
"parentName": "InviteWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
|
|
"description": "Emitted when invites are created. You can listen to this event\nto send an email to the invited users, for example.",
|
|
"workflows": [
|
|
"createInvitesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "invite.deleted",
|
|
"parentName": "InviteWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
|
|
"description": "Emitted when invites are deleted.",
|
|
"workflows": [
|
|
"deleteInvitesWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "invite.resent",
|
|
"parentName": "InviteWorkflowEvents",
|
|
"propertyName": "RESENT",
|
|
"payload": "```ts\n{\n id, // The ID of the invite\n}\n```",
|
|
"description": "Emitted when invites should be resent because their token was\nrefreshed. You can listen to this event to send an email to the invited users,\nfor example.",
|
|
"workflows": [
|
|
"refreshInviteTokensWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "region.updated",
|
|
"parentName": "RegionWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the region\n}\n```",
|
|
"description": "Emitted when regions are updated.",
|
|
"workflows": [
|
|
"updateRegionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "region.created",
|
|
"parentName": "RegionWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the region\n}\n```",
|
|
"description": "Emitted when regions are created.",
|
|
"workflows": [
|
|
"createRegionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "region.deleted",
|
|
"parentName": "RegionWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the region\n}\n```",
|
|
"description": "Emitted when regions are deleted.",
|
|
"workflows": [
|
|
"deleteRegionsWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "shipment.created",
|
|
"parentName": "FulfillmentWorkflowEvents",
|
|
"propertyName": "SHIPMENT_CREATED",
|
|
"payload": "```ts\n{\n id, // the ID of the fulfillment\n no_notification, // (boolean) whether to notify the customer\n}\n```",
|
|
"description": "Emitted when a shipment is created for an order.",
|
|
"workflows": [
|
|
"createOrderShipmentWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "delivery.created",
|
|
"parentName": "FulfillmentWorkflowEvents",
|
|
"propertyName": "DELIVERY_CREATED",
|
|
"payload": "```ts\n{\n id, // the ID of the fulfillment\n}\n```",
|
|
"description": "Emitted when a fulfillment is marked as delivered.",
|
|
"workflows": [
|
|
"markOrderFulfillmentAsDeliveredWorkflow"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "shipping-option-type.updated",
|
|
"parentName": "ShippingOptionTypeWorkflowEvents",
|
|
"propertyName": "UPDATED",
|
|
"payload": "```ts\n{\n id, // The ID of the shipping option type\n}\n```",
|
|
"description": "Emitted when shipping option types are updated.",
|
|
"workflows": [
|
|
"updateShippingOptionTypesWorkflow"
|
|
],
|
|
"since": "2.10.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "shipping-option-type.created",
|
|
"parentName": "ShippingOptionTypeWorkflowEvents",
|
|
"propertyName": "CREATED",
|
|
"payload": "```ts\n{\n id, // The ID of the shipping option type\n}\n```",
|
|
"description": "Emitted when shipping option types are created.",
|
|
"workflows": [
|
|
"createShippingOptionTypesWorkflow"
|
|
],
|
|
"since": "2.10.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "shipping-option-type.deleted",
|
|
"parentName": "ShippingOptionTypeWorkflowEvents",
|
|
"propertyName": "DELETED",
|
|
"payload": "```ts\n{\n id, // The ID of the shipping option type\n}\n```",
|
|
"description": "Emitted when shipping option types are deleted.",
|
|
"workflows": [
|
|
"deleteShippingOptionTypesWorkflow"
|
|
],
|
|
"since": "2.10.0",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "payment.captured",
|
|
"parentName": "PaymentEvents",
|
|
"propertyName": "CAPTURED",
|
|
"payload": "```ts\n{\n id, // the ID of the payment\n}\n```",
|
|
"description": "Emitted when a payment is captured.",
|
|
"workflows": [
|
|
"capturePaymentWorkflow",
|
|
"processPaymentWorkflow",
|
|
"markPaymentCollectionAsPaid"
|
|
],
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "payment.refunded",
|
|
"parentName": "PaymentEvents",
|
|
"propertyName": "REFUNDED",
|
|
"payload": "```ts\n{\n id, // the ID of the payment\n}\n```",
|
|
"description": "Emitted when a payment is refunded.",
|
|
"workflows": [
|
|
"refundPaymentWorkflow"
|
|
],
|
|
"deprecated": false
|
|
}
|
|
] |