Events-Category

Overview

Webhook events related to the creation, update, and deletion of a category tree and to the creation and deletion of a category assignment.

Available events

Event type
Event schema

category.created

{
  "id": "String",
  "parentId": "String",
  "name": {
    "name" : "Map"
  },
  "description": {
    "description": "Map"
  },
  "slug": {
    "code": "Map"
  },
  "ecn": {
    "externalCategoryNumbers": [
      "String"
    ]
  },
  "validity": {
    "from": "String",
    "to": "String"
  },
  "position": {
    "position": "Number"
  },
  "publish": {
    "published": "Boolean"
  },
  "mixins": "Map",
  "metadata": {
    "version": "Number",
    "createdAt": "String",
    "modifiedAt": "String"
  }
}

category.updated

{
  "id": "String",
  "parentId": "String",
  "name": {
    "name" : "Map"
  },
  "description": {
    "description": "Map"
  },
  "slug": {
    "code": "Map"
  },
  "ecn": {
    "externalCategoryNumbers": [
      "String"
    ]
  },
  "validity": {
    "from": "String",
    "to": "String"
  },
  "position": {
    "position": "Number"
  },
  "publish": {
    "published": "Boolean"
  },
  "mixins": "Map",
  "metadata": {
    "version": "Number",
    "createdAt": "String",
    "modifiedAt": "String"
  }
}

category.deleted

{
  "id": "String",
  "parentId": "String"
}

assignment.created

{
  "categoryId": "String",
  "assignment": {
    "id": "String",
    "categoryId": "String",
    "createdAt": "String",
    "ref": {
      "id": "String",
      "type": "String"
    }
  },
  "metadata": {
    "createdAt": "String"
  }
}

assignment.deleted

{
  "categoryId": "String",
  "assignments": [
    {
      "id": "String",
      "categoryId": "String",
      "createdAt": "String",
      "ref": {
        "id": "String",
        "type": "String"
      }
    }
  ]
}

Last updated

Was this helpful?