Skip to main content

Custom API Entries

A Custom API Entry is a specific instance of a resource, such as a single product.


You can integrate Commerce Extensions with your external systems by observing the appropriate events. For more information, see Integrations.

Given you have a Custom API with api_type of wishlist_ext and you want to perform additional processing when an action is taken, like when a wishlist is created:

curl -X POST \
-H "Authorization: Bearer XXXX" \
-H "Content-Type: application/json" \
-d $ {
"data": {
"type": "wishlist_ext",
"name": "My Wishlist",
"items_count" 0,
"keep_purchased": false

When you create an integration with wishlist_ext.created in observes field. Then the configured webhook or aws_sqs will receive the appropriate message.

You can configure integrations to observe the following events for your Custom API Entries:

  • Created
  • Updated
  • Deleted