> For the complete documentation index, see [llms.txt](https://docs.ergonode.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-events.md).

# Synchronization events

## Attributes

#### attribute\_created

included with events: [attribute\_created](/apps2/detailed-reference/manifest.md#attribute_created)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_created",
  "payload": {
    "code": "attribute_code",
    "type": "TEXT",
    "scope": "local",
    "name": [
      {
        "language": "en_GB",
        "value": "This is the attribute name"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "code": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
        },
        "scope": {
          "type": "string",
          "enum": ["local", "global"]
        },
        "name": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "language",
              "value"
            ]
          }
        }
      },
      "required": [
        "code",
        "type",
        "scope",
        "name"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### attribute\_name\_changed

included with events: [attribute\_created](/apps2/detailed-reference/manifest.md#attribute_created), [attribute\_updated](/apps2/detailed-reference/manifest.md#attribute_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_name_changed",
  "payload": {
    "name": [
      {
        "language": "en_GB",
        "value": "This is the new attribute name"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "name": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "language",
              "value"
            ]
          }
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### attribute\_option\_code\_changed

included with events: [attribute\_created](/apps2/detailed-reference/manifest.md#attribute_created), [attribute\_updated](/apps2/detailed-reference/manifest.md#attribute_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_option_code_changed",
  "payload": {
    "option_code": "option_code",
    "previous_option_code": "previous_option_code"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "option_code": {
          "type": "string"
        },
        "previous_option_code": {
          "type": "string"
        }
      },
      "required": [
        "option_code",
        "previous_option_code"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### attribute\_option\_created

included with events: [attribute\_created](/apps2/detailed-reference/manifest.md#attribute_created), [attribute\_updated](/apps2/detailed-reference/manifest.md#attribute_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_option_created",
  "payload": {
    "option_code": "option_code",
    "option_name": [
      {
        "language": "en_GB",
        "value": "This is the option name"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "option_code": {
          "type": "string"
        },
        "option_name": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "language",
              "value"
            ]
          }
        }
      },
      "required": [
        "option_code",
        "option_name"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### attribute\_option\_deleted

included with events: [attribute\_updated](/apps2/detailed-reference/manifest.md#attribute_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_option_deleted",
  "payload": {
    "option_code": "option_code"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "option_code": {
          "type": "string"
        }
      },
      "required": [
        "option_code"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### attribute\_option\_name\_changed

included with events: [attribute\_created](/apps2/detailed-reference/manifest.md#attribute_created), [attribute\_updated](/apps2/detailed-reference/manifest.md#attribute_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_option_name_changed",
  "payload": {
    "option_code": "option_code",
    "option_name": [
      {
        "language": "en_GB",
        "value": "This is the new option name"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "option_code": {
          "type": "string"
        },
        "option_name": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "language",
              "value"
            ]
          }
        }
      },
      "required": [
        "option_code",
        "option_name"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

## Categories

#### category\_created

included with events: [category\_created](/apps2/detailed-reference/manifest.md#category_created)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "category_created",
  "payload": {
    "code": "category_code",
    "name": [
      {
        "language": "en_GB",
        "value": "This is the category name"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "code": {
          "type": "string"
        },
        "name": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "language",
              "value"
            ]
          }
        }
      },
      "required": [
        "code",
        "name"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### category\_name\_changed

included with events: [category\_created](/apps2/detailed-reference/manifest.md#category_created), [category\_updated](/apps2/detailed-reference/manifest.md#category_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "attribute_name_changed",
  "payload": {
    "name": [
      {
        "language": "en_GB",
        "value": "This is the new category name"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "code": {
          "type": "string"
        },
        "name": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "language",
              "value"
            ]
          }
        }
      },
      "required": [
        "code",
        "name"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

## Products

#### product\_added\_to\_category

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created), [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_added_to_category",
  "payload": {
    "category_code": "category_code"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "category_code": {
          "type": "string"
        }
      },
      "required": [
        "category_code"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_binding\_added

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created), [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_binding_added",
  "payload": {
    "attribute_code": "attribute_code"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "attribute_code": {
          "type": "string"
        }
      },
      "required": [
        "attribute_code"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_binding\_removed

included with events: [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_binding_removed",
  "payload": {
    "attribute_code": "attribute_code"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "attribute_code": {
          "type": "string"
        }
      },
      "required": [
        "attribute_code"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_child\_added

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created), [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_child_added",
  "payload": {
    "child_sku": "Child sku",
    "child_quantity": 2
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "child_sku": {
          "type": "string"
        },
        "child_quantity": {
          "type": "integer"
        }
      },
      "required": [
        "child_sku",
        "child_quantity"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_child\_quantity\_changed

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created), [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_child_quantity_changed",
  "payload": {
    "child_sku": "Child sku",
    "child_quantity": 2
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "child_sku": {
          "type": "string"
        },
        "child_quantity": {
          "type": "integer"
        }
      },
      "required": [
        "child_sku",
        "child_quantity"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_child\_removed

included with events: [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_child_removed",
  "payload": {
    "child_sku": "Child sku"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "child_sku": {
          "type": "string"
        }
      },
      "required": [
        "child_sku"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_created

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_created",
  "payload": {
    "sku": "Product SKU",
    "type": "SIMPLE-PRODUCT",
    "category_codes": ["category_code"]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "sku": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": ["SIMPLE-PRODUCT", "GROUPING-PRODUCT", "VARIABLE-PRODUCT"]
        },
        "category_codes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "sku",
        "type",
        "category_codes"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_removed\_from\_category

included with events: [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_removed_from_category",
  "payload": {
    "category_code": "category_code"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "category_code": {
          "type": "string"
        }
      },
      "required": [
        "category_code"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_value\_added

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created), [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_value_added",
  "payload": {
    "attribute_code": "attribute_code",
    "attribute_type": "TEXT",
    "attribute_scope": "local",
    "value": [
      {
        "language": "en_GB",
        "translation": "This is the attribute value"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "attribute_code": {
          "type": "string"
        },
        "attribute_type": {
          "type": "string",
          "enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
        },
        "attribute_scope": {
          "type": "string",
          "enum": ["local", "global"]
        },
        "value": {
          "oneOf": [
            {
              "type": "string",
              "description": "For global attribute of type DATE, SELECT, TEXT_AREA and TEXT"
            },
            {
              "type": "number",
              "description": "For global attribute of type NUMERIC, PRICE and UNIT"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "For global attribute of type MULTI_SELECT and PRODUCT_RELATION"
            },
            {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                }
              },
              "required": [
                "url",
                "path"
              ],
              "description": "For global attribute of type IMAGE"
            },
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "path": {
                    "type": "string"
                  }
                },
                "required": [
                  "url",
                  "path"
                ]
              },
              "description": "For global attribute of type FILE and GALLERY"
            },
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string"
                  },
                  "value": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/AttributeValue"
                      }
                    ]
                  }
                },
                "required": [
                  "language",
                  "value"
                ]
              },
              "description": "For local attributes same types as for global wrapped in translation array"
            }
          ]
        }
      },
      "required": [
        "attribute_code",
        "attribute_type",
        "attribute_scope",
        "value"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_value\_changed

included with events: [product\_created](/apps2/detailed-reference/manifest.md#product_created), [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_value_changed",
  "payload": {
    "attribute_code": "attribute_code",
    "attribute_type": "TEXT",
    "attribute_scope": "global",
    "value": "This is the attribute value"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "attribute_code": {
          "type": "string"
        },
        "attribute_type": {
          "type": "string",
          "enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
        },
        "attribute_scope": {
          "type": "string",
          "enum": ["local", "global"]
        },
        "value": {
          "oneOf": [
            {
              "type": "string",
              "description": "For global attribute of type DATE, SELECT, TEXT_AREA and TEXT"
            },
            {
              "type": "number",
              "description": "For global attribute of type NUMERIC, PRICE and UNIT"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "For global attribute of type MULTI_SELECT and PRODUCT_RELATION"
            },
            {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                }
              },
              "required": [
                "url",
                "path"
              ],
              "description": "For global attribute of type IMAGE"
            },
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "path": {
                    "type": "string"
                  }
                },
                "required": [
                  "url",
                  "path"
                ]
              },
              "description": "For global attribute of type FILE and GALLERY"
            },
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string"
                  },
                  "value": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/AttributeValue"
                      }
                    ]
                  }
                },
                "required": [
                  "language",
                  "value"
                ]
              },
              "description": "For local attributes same types as for global wrapped in translation array"
            }
          ]
        }
      },
      "required": [
        "attribute_code",
        "attribute_type",
        "attribute_scope",
        "value"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_value\_removed

included with events: [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_value_removed",
  "payload": {
    "attribute_code": "attribute_code",
    "attribute_type": "TEXT"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "attribute_code": {
          "type": "string"
        },
        "attribute_type": {
          "type": "string",
          "enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
        }
      },
      "required": [
        "attribute_code",
        "attribute_type"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_variant\_added

included with events: [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_variant_added",
  "payload": {
    "variant_sku": "Variant SKU",
    "binding_values": [
      {
        "attribute_code": "attribute_code",
        "attribute_type": "SELECT",
        "attribute_scope": "global",
        "value": "attribute_option_code"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "variant_sku": {
          "type": "string"
        },
        "binding_values": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "attribute_code": {
                "type": "string"
              },
              "attribute_type": {
                "type": "string",
                "enum": ["SELECT"]
              },
              "attribute_scope": {
                "type": "string",
                "enum": ["global"]
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "attribute_code",
              "attribute_type",
              "attribute_scope",
              "value"
            ]
          }
        }
      },
      "required": [
        "variant_sku",
        "binding_values"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}

#### product\_variant\_removed

included with events: [product\_updated](/apps2/detailed-reference/manifest.md#product_updated)

{% tabs %}
{% tab title="Example" %}

```json
{
  "type": "product_variant_removed",
  "payload": {
    "variant_sku": "Variant SKU"
  }
}
```

{% endtab %}

{% tab title="Schema" %}

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of synchronization event."
    },
    "payload": {
      "type": "object",
      "description": "The detailed payload of the synchronization event.",
      "properties": {
        "variant_sku": {
          "type": "string"
        }
      },
      "required": [
        "variant_sku"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.