docs: fix events payloads (#14131)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-11-26 16:12:00 +02:00
1 parent c1ede88a7e
commit c3cebdfe80
139 files changed
+1057 -904

No files matched your search

@@ -20,6 +20,8 @@ If the workflow fails, it won't emit the event at all.
## Example
To emit a single event with a data payload:
```ts
emitEventStep({
eventName: "custom.created",
@@ -29,6 +31,20 @@ emitEventStep({
})
```
To emit an event multiple times with different data payloads, pass an array of objects to the `data` property:
```ts
emitEventStep({
eventName: "custom.created",
data: [
// emit will be emitted three times, once per each object in the array
{ id: "123" },
{ id: "456" },
{ id: "789" }
]
})
```
## Input
<TypeList types={[{"name":"Input","type":"`Input`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="emitEventStep"/>
@@ -202,18 +202,18 @@ Emitted when a customer is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the customer
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "customer.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -234,18 +234,18 @@ Emitted when a customer is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the customer
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "customer.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -210,18 +210,18 @@ Emitted when a customer is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the customer
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "customer.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -187,18 +187,18 @@ Emitted when a customer is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the customer
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "customer.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -228,18 +228,18 @@ Emitted when a customer is updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the customer
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "customer.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -207,18 +207,18 @@ Emitted when users are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the user
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "user.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -187,18 +187,18 @@ to send an email to the invited users, for example.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the invite
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "invite.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -174,18 +174,18 @@ Emitted when invites are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the invite
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "invite.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -184,18 +184,18 @@ for example.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the invite
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "invite.resent",
payload: `\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -177,18 +177,18 @@ Emitted when an order is archived.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the order
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "order.archived",
payload: `\`\`\`ts
[{
{
id, // The ID of the order
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -219,18 +219,18 @@ Emitted when orders are completed.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the order
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "order.completed",
payload: `\`\`\`ts
[{
{
id, // The ID of the order
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -243,18 +243,18 @@ Emitted when product variants are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -268,18 +268,18 @@ Emitted when product variants are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -293,18 +293,18 @@ Emitted when product variants are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -256,18 +256,18 @@ Emitted when product variants are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -281,18 +281,18 @@ Emitted when products are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -306,18 +306,18 @@ Emitted when products are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -331,18 +331,18 @@ Emitted when products are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -228,18 +228,18 @@ Emitted when product collections are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product collection
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-collection.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -251,18 +251,18 @@ Emitted when product options are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product option
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-option.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -228,18 +228,18 @@ Emitted when product tags are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product tag
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-tag.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -228,18 +228,18 @@ Emitted when product types are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product type
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-type.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -274,18 +274,18 @@ Emitted when product variants are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -306,18 +306,18 @@ Emitted when product variants are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -331,18 +331,18 @@ Emitted when products are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -205,18 +205,18 @@ Emitted when product collections are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product collection
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-collection.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -205,18 +205,18 @@ Emitted when product options are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product option
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-option.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -204,18 +204,18 @@ Emitted when product tags are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product tag
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-tag.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -205,18 +205,18 @@ Emitted when product types are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product type
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-type.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -207,18 +207,18 @@ Emitted when product variants are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -207,18 +207,18 @@ Emitted when products are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -240,18 +240,18 @@ Emitted when product variants are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -265,18 +265,18 @@ Emitted when products are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -290,18 +290,18 @@ Emitted when products are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -315,18 +315,18 @@ Emitted when products are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -240,18 +240,18 @@ Emitted when product collections are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product collection
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-collection.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -239,18 +239,18 @@ Emitted when product options are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product option
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-option.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -240,18 +240,18 @@ Emitted when product tags are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product tag
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-tag.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -240,18 +240,18 @@ Emitted when product types are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product type
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-type.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -422,18 +422,18 @@ Emitted when product variants are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product variant
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-variant.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -420,18 +420,18 @@ Emitted when products are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -214,18 +214,18 @@ Emitted when product categories are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product category
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-category.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -195,18 +195,18 @@ Emitted when product categories are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product category
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-category.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -226,18 +226,18 @@ Emitted when product categories are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the product category
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "product-category.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -198,18 +198,18 @@ Emitted when regions are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the region
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "region.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -175,18 +175,18 @@ Emitted when regions are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the region
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "region.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -202,18 +202,18 @@ Emitted when regions are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the region
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "region.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -186,18 +186,18 @@ Emitted when sales channels are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the sales channel
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "sales-channel.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -175,18 +175,18 @@ Emitted when sales channels are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the sales channel
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "sales-channel.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -198,18 +198,18 @@ Emitted when sales channels are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the sales channel
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "sales-channel.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -245,18 +245,18 @@ Emitted when shipping option types are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the shipping option type
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "shipping-option-type.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -214,18 +214,18 @@ Emitted when shipping option types are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the shipping option type
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "shipping-option-type.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -249,18 +249,18 @@ Emitted when shipping option types are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the shipping option type
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "shipping-option-type.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -201,18 +201,18 @@ Emitted when users are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the user
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "user.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -198,18 +198,18 @@ Emitted when users are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the user
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "user.created",
payload: `\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -178,18 +178,18 @@ Emitted when users are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the user
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "user.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -181,18 +181,18 @@ Emitted when users are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the user
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "user.deleted",
payload: `\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -190,18 +190,18 @@ Emitted when users are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
{
id, // The ID of the user
}]
}
```
</Table.Cell>
<Table.Cell>
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
event: "user.updated",
payload: `\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``
}}/>
</Table.Cell>
@@ -269,9 +269,9 @@ Emitted when a customer is deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "customercreated", children: (<>customer.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.created" payload={`\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``} />
Emitted when a customer is created.
@@ -279,9 +279,9 @@ Emitted when a customer is created.
#### Payload
```ts
[{
{
id, // The ID of the customer
}]
}
```
#### Workflows Emitting this Event
@@ -294,9 +294,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "customerupdated", children: (<>customer.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``} />
Emitted when a customer is updated.
@@ -304,9 +304,9 @@ Emitted when a customer is updated.
#### Payload
```ts
[{
{
id, // The ID of the customer
}]
}
```
#### Workflows Emitting this Event
@@ -318,9 +318,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "customerdeleted", children: (<>customer.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the customer
}]
}
\`\`\``} />
Emitted when a customer is deleted.
@@ -328,9 +328,9 @@ Emitted when a customer is deleted.
#### Payload
```ts
[{
{
id, // The ID of the customer
}]
}
```
#### Workflows Emitting this Event
@@ -506,9 +506,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "invitecreated", children: (<>invite.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.created" payload={`\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``} />
Emitted when invites are created. You can listen to this event
@@ -517,9 +517,9 @@ to send an email to the invited users, for example.
#### Payload
```ts
[{
{
id, // The ID of the invite
}]
}
```
#### Workflows Emitting this Event
@@ -531,9 +531,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "invitedeleted", children: (<>invite.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``} />
Emitted when invites are deleted.
@@ -541,9 +541,9 @@ Emitted when invites are deleted.
#### Payload
```ts
[{
{
id, // The ID of the invite
}]
}
```
#### Workflows Emitting this Event
@@ -555,9 +555,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "inviteresent", children: (<>invite.resent</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.resent" payload={`\`\`\`ts
[{
{
id, // The ID of the invite
}]
}
\`\`\``} />
Emitted when invites should be resent because their token was
@@ -567,9 +567,9 @@ for example.
#### Payload
```ts
[{
{
id, // The ID of the invite
}]
}
```
#### Workflows Emitting this Event
@@ -908,9 +908,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "ordercompleted", children: (<>order.completed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.completed" payload={`\`\`\`ts
[{
{
id, // The ID of the order
}]
}
\`\`\``} />
Emitted when orders are completed.
@@ -918,9 +918,9 @@ Emitted when orders are completed.
#### Payload
```ts
[{
{
id, // The ID of the order
}]
}
```
#### Workflows Emitting this Event
@@ -932,9 +932,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "orderarchived", children: (<>order.archived</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.archived" payload={`\`\`\`ts
[{
{
id, // The ID of the order
}]
}
\`\`\``} />
Emitted when an order is archived.
@@ -942,9 +942,9 @@ Emitted when an order is archived.
#### Payload
```ts
[{
{
id, // The ID of the order
}]
}
```
#### Workflows Emitting this Event
@@ -1273,9 +1273,9 @@ Emitted when product categories are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-categorycreated", children: (<>product-category.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``} />
Emitted when product categories are created.
@@ -1283,9 +1283,9 @@ Emitted when product categories are created.
#### Payload
```ts
[{
{
id, // The ID of the product category
}]
}
```
#### Workflows Emitting this Event
@@ -1297,9 +1297,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-categoryupdated", children: (<>product-category.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``} />
Emitted when product categories are updated.
@@ -1307,9 +1307,9 @@ Emitted when product categories are updated.
#### Payload
```ts
[{
{
id, // The ID of the product category
}]
}
```
#### Workflows Emitting this Event
@@ -1321,9 +1321,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-categorydeleted", children: (<>product-category.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product category
}]
}
\`\`\``} />
Emitted when product categories are deleted.
@@ -1331,9 +1331,9 @@ Emitted when product categories are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product category
}]
}
```
#### Workflows Emitting this Event
@@ -1388,9 +1388,9 @@ Emitted when product collections are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-collectioncreated", children: (<>product-collection.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``} />
Emitted when product collections are created.
@@ -1398,9 +1398,9 @@ Emitted when product collections are created.
#### Payload
```ts
[{
{
id, // The ID of the product collection
}]
}
```
#### Workflows Emitting this Event
@@ -1412,9 +1412,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-collectionupdated", children: (<>product-collection.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``} />
Emitted when product collections are updated.
@@ -1422,9 +1422,9 @@ Emitted when product collections are updated.
#### Payload
```ts
[{
{
id, // The ID of the product collection
}]
}
```
#### Workflows Emitting this Event
@@ -1436,9 +1436,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-collectiondeleted", children: (<>product-collection.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product collection
}]
}
\`\`\``} />
Emitted when product collections are deleted.
@@ -1446,9 +1446,9 @@ Emitted when product collections are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product collection
}]
}
```
#### Workflows Emitting this Event
@@ -1503,9 +1503,9 @@ Emitted when product options are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-optionupdated", children: (<>product-option.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``} />
Emitted when product options are updated.
@@ -1513,9 +1513,9 @@ Emitted when product options are updated.
#### Payload
```ts
[{
{
id, // The ID of the product option
}]
}
```
#### Workflows Emitting this Event
@@ -1527,9 +1527,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-optioncreated", children: (<>product-option.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``} />
Emitted when product options are created.
@@ -1537,9 +1537,9 @@ Emitted when product options are created.
#### Payload
```ts
[{
{
id, // The ID of the product option
}]
}
```
#### Workflows Emitting this Event
@@ -1551,9 +1551,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-optiondeleted", children: (<>product-option.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product option
}]
}
\`\`\``} />
Emitted when product options are deleted.
@@ -1561,9 +1561,9 @@ Emitted when product options are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product option
}]
}
```
#### Workflows Emitting this Event
@@ -1618,9 +1618,9 @@ Emitted when product tags are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-tagupdated", children: (<>product-tag.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``} />
Emitted when product tags are updated.
@@ -1628,9 +1628,9 @@ Emitted when product tags are updated.
#### Payload
```ts
[{
{
id, // The ID of the product tag
}]
}
```
#### Workflows Emitting this Event
@@ -1642,9 +1642,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-tagcreated", children: (<>product-tag.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``} />
Emitted when product tags are created.
@@ -1652,9 +1652,9 @@ Emitted when product tags are created.
#### Payload
```ts
[{
{
id, // The ID of the product tag
}]
}
```
#### Workflows Emitting this Event
@@ -1666,9 +1666,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-tagdeleted", children: (<>product-tag.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product tag
}]
}
\`\`\``} />
Emitted when product tags are deleted.
@@ -1676,9 +1676,9 @@ Emitted when product tags are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product tag
}]
}
```
#### Workflows Emitting this Event
@@ -1733,9 +1733,9 @@ Emitted when product types are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-typeupdated", children: (<>product-type.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``} />
Emitted when product types are updated.
@@ -1743,9 +1743,9 @@ Emitted when product types are updated.
#### Payload
```ts
[{
{
id, // The ID of the product type
}]
}
```
#### Workflows Emitting this Event
@@ -1757,9 +1757,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-typecreated", children: (<>product-type.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``} />
Emitted when product types are created.
@@ -1767,9 +1767,9 @@ Emitted when product types are created.
#### Payload
```ts
[{
{
id, // The ID of the product type
}]
}
```
#### Workflows Emitting this Event
@@ -1781,9 +1781,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-typedeleted", children: (<>product-type.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product type
}]
}
\`\`\``} />
Emitted when product types are deleted.
@@ -1791,9 +1791,9 @@ Emitted when product types are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product type
}]
}
```
#### Workflows Emitting this Event
@@ -1848,9 +1848,9 @@ Emitted when product variants are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-variantupdated", children: (<>product-variant.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``} />
Emitted when product variants are updated.
@@ -1858,9 +1858,9 @@ Emitted when product variants are updated.
#### Payload
```ts
[{
{
id, // The ID of the product variant
}]
}
```
#### Workflows Emitting this Event
@@ -1873,9 +1873,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-variantcreated", children: (<>product-variant.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``} />
Emitted when product variants are created.
@@ -1883,9 +1883,9 @@ Emitted when product variants are created.
#### Payload
```ts
[{
{
id, // The ID of the product variant
}]
}
```
#### Workflows Emitting this Event
@@ -1901,9 +1901,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "product-variantdeleted", children: (<>product-variant.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product variant
}]
}
\`\`\``} />
Emitted when product variants are deleted.
@@ -1911,9 +1911,9 @@ Emitted when product variants are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product variant
}]
}
```
#### Workflows Emitting this Event
@@ -1969,9 +1969,9 @@ Emitted when products are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "productupdated", children: (<>product.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``} />
Emitted when products are updated.
@@ -1979,9 +1979,9 @@ Emitted when products are updated.
#### Payload
```ts
[{
{
id, // The ID of the product
}]
}
```
#### Workflows Emitting this Event
@@ -1995,9 +1995,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "productcreated", children: (<>product.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.created" payload={`\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``} />
Emitted when products are created.
@@ -2005,9 +2005,9 @@ Emitted when products are created.
#### Payload
```ts
[{
{
id, // The ID of the product
}]
}
```
#### Workflows Emitting this Event
@@ -2021,9 +2021,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "productdeleted", children: (<>product.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the product
}]
}
\`\`\``} />
Emitted when products are deleted.
@@ -2031,9 +2031,9 @@ Emitted when products are deleted.
#### Payload
```ts
[{
{
id, // The ID of the product
}]
}
```
#### Workflows Emitting this Event
@@ -2090,9 +2090,9 @@ Emitted when regions are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "regionupdated", children: (<>region.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``} />
Emitted when regions are updated.
@@ -2100,9 +2100,9 @@ Emitted when regions are updated.
#### Payload
```ts
[{
{
id, // The ID of the region
}]
}
```
#### Workflows Emitting this Event
@@ -2114,9 +2114,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "regioncreated", children: (<>region.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.created" payload={`\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``} />
Emitted when regions are created.
@@ -2124,9 +2124,9 @@ Emitted when regions are created.
#### Payload
```ts
[{
{
id, // The ID of the region
}]
}
```
#### Workflows Emitting this Event
@@ -2138,9 +2138,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "regiondeleted", children: (<>region.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the region
}]
}
\`\`\``} />
Emitted when regions are deleted.
@@ -2148,9 +2148,9 @@ Emitted when regions are deleted.
#### Payload
```ts
[{
{
id, // The ID of the region
}]
}
```
#### Workflows Emitting this Event
@@ -2205,9 +2205,9 @@ Emitted when sales channels are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "sales-channelcreated", children: (<>sales-channel.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.created" payload={`\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``} />
Emitted when sales channels are created.
@@ -2215,9 +2215,9 @@ Emitted when sales channels are created.
#### Payload
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
#### Workflows Emitting this Event
@@ -2229,9 +2229,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "sales-channelupdated", children: (<>sales-channel.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``} />
Emitted when sales channels are updated.
@@ -2239,9 +2239,9 @@ Emitted when sales channels are updated.
#### Payload
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
#### Workflows Emitting this Event
@@ -2253,9 +2253,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "sales-channeldeleted", children: (<>sales-channel.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the sales channel
}]
}
\`\`\``} />
Emitted when sales channels are deleted.
@@ -2263,9 +2263,9 @@ Emitted when sales channels are deleted.
#### Payload
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
#### Workflows Emitting this Event
@@ -2326,9 +2326,9 @@ Emitted when shipping option types are deleted.
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``} />
Emitted when shipping option types are updated.
@@ -2336,9 +2336,9 @@ Emitted when shipping option types are updated.
#### Payload
```ts
[{
{
id, // The ID of the shipping option type
}]
}
```
#### Workflows Emitting this Event
@@ -2353,9 +2353,9 @@ The following workflows emit this event when they're executed. These workflows a
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.created" payload={`\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``} />
Emitted when shipping option types are created.
@@ -2363,9 +2363,9 @@ Emitted when shipping option types are created.
#### Payload
```ts
[{
{
id, // The ID of the shipping option type
}]
}
```
#### Workflows Emitting this Event
@@ -2380,9 +2380,9 @@ The following workflows emit this event when they're executed. These workflows a
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the shipping option type
}]
}
\`\`\``} />
Emitted when shipping option types are deleted.
@@ -2390,9 +2390,9 @@ Emitted when shipping option types are deleted.
#### Payload
```ts
[{
{
id, // The ID of the shipping option type
}]
}
```
#### Workflows Emitting this Event
@@ -2447,9 +2447,9 @@ Emitted when users are deleted.
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "usercreated", children: (<>user.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.created" payload={`\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``} />
Emitted when users are created.
@@ -2457,9 +2457,9 @@ Emitted when users are created.
#### Payload
```ts
[{
{
id, // The ID of the user
}]
}
```
#### Workflows Emitting this Event
@@ -2473,9 +2473,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "userupdated", children: (<>user.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.updated" payload={`\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``} />
Emitted when users are updated.
@@ -2483,9 +2483,9 @@ Emitted when users are updated.
#### Payload
```ts
[{
{
id, // The ID of the user
}]
}
```
#### Workflows Emitting this Event
@@ -2497,9 +2497,9 @@ The following workflows emit this event when they're executed. These workflows a
---
<EventHeader headerLvl="3" headerProps={{ id: "userdeleted", children: (<>user.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.deleted" payload={`\`\`\`ts
[{
{
id, // The ID of the user
}]
}
\`\`\``} />
Emitted when users are deleted.
@@ -2507,9 +2507,9 @@ Emitted when users are deleted.
#### Payload
```ts
[{
{
id, // The ID of the user
}]
}
```
#### Workflows Emitting this Event