Adobe Commerce integration starter kit is for Beta users only and is not yet accessible to all customers. Sign up to be notified about updates and beta opportunities.

Real-time integrations

The following sections demonstrate all the real-time integrations that Adobe Commerce Extensibility Integration Kit has to offer, including the synchronous webhook action and an example implementation of a webhook.

Synchronous webhook action

The contents of the ./actions/webhook directory expose a webhook that can be invoked synchronously from Commerce to affect the behavior of a particular business flow.

The ./actions/webhook/check-stock folder provides a reference implementation of a synchronous webhook action.

To get the URL of the webhook, run the following command:

aio runtime action get webhook/check-stock --url
Copied to your clipboard
aio runtime action get webhook/check-stock --url

By default, synchronous webhook actions have the following response:

Success

Failure

// ./actions/responses.js#webhookSuccessResponse
return {
  statusCode: 200,
  body: {
    op: 'success'
  }
}
Copied to your clipboard
// ./actions/responses.js#webhookSuccessResponse
return {
  statusCode: 200,
  body: {
    op: 'success'
  }
}

// ./actions/responses.js#webhookSuccessResponse
return {
  error: {
    statusCode: 200,
    body : {
      op: 'exception'
      message: 'YOUR ERROR MESSAGE'
    }
  }
}
Copied to your clipboard
// ./actions/responses.js#webhookSuccessResponse
return {
  error: {
    statusCode: 200,
    body : {
      op: 'exception'
      message: 'YOUR ERROR MESSAGE'
    }
  }
}

Webhooks example

The Adobe Commerce integration starter kit can use the Adobe Commerce webhook module to allow intercepting flows in Adobe Commerce.

This reference implementation makes a real-time query to a third-party system to determine whether the product a shopper placed in their cart is in stock.

If you do not want to implement webhooks, comment out the webhook section of the starter kit's app.config.yaml file before running aio app deploy.

Webhooks are enabled by default. If you initially disabled webhooks, you can reenable them by uncommenting the webhook section of the app.config.yaml file. Additionally, you will need to redeploy the project and repeat the onboarding process.

The runtime action included is in the starter kit package in the following location:

actions/webhook/check-stock/index.js

You must implement the stock-checking logic on an external service.

Configure webhook

Follow admin configuration to modify your webhook and define the connection between Adobe Commerce and your backoffice system using the observer.checkout_cart_product_add_before method.

{
  "data": {
    "cart_id": "cart id",
    "items": [
      {
        "item_id": 1,
        "sku": "Product SKU",
        "qty": "Cart item qty"
      }
    ]
  }
}
Copied to your clipboard
{
  "data": {
    "cart_id": "cart id",
    "items": [
      {
        "item_id": 1,
        "sku": "Product SKU",
        "qty": "Cart item qty"
      }
    ]
  }
}

Validation

The following parameters are required:

data
data.cart_id
data.items

Sample validation logic is provided in the following location in the starter kit package.

webhook\check-stock\validator.js

You can modify this file to add more validations to the validateData method, if necessary.

Business logic

The example runtime action webhook\check-stock\index.js references the checkAvailableStock() method in the webhook\check-stock\stock.js file. You must add custom business logic to the params in the stock.js file to test authentication with your third-party backoffice system.

You can also add custom responses.

Modify `.env` parameters

You can access any environment parameters from params. Add any required parameters to the actions/webhook/check-stock/actions.config.yaml under check-stock -> inputs:

check-stock:
  function: check-stock/index.js
  web: 'yes'
  runtime: nodejs:16
  inputs:
    LOG_LEVEL: debug
    
    HERE_YOUR_PARAM: $YOUR_CUSTOM_PARAMETER
    
  annotations:
    require-adobe-auth: false
    final: true
Copied to your clipboard
check-stock:
  function: check-stock/index.js
  web: 'yes'
  runtime: nodejs:16
  inputs:
    LOG_LEVEL: debug
    
    HERE_YOUR_PARAM: $YOUR_CUSTOM_PARAMETER
    
  annotations:
    require-adobe-auth: false
    final: true

Responses

Error response:

return {   
  statusCode: 200,
  body: {
    op: 'exception',
    message: 'Error message'
  }
}
Copied to your clipboard
return {   
  statusCode: 200,
  body: {
    op: 'exception',
    message: 'Error message'
  }
}

Success response:

return {
  statusCode: 200,
  body: {
    op: 'success'
  }
}
Copied to your clipboard
return {
  statusCode: 200,
  body: {
    op: 'success'
  }
}

These responses are defined in webhook\check-stock\index.js and are adapted from the Commerce webhook responses. You can modify the response implementation in your code as needed.

Event-based integrations

Expose Commerce data