sfcc-ocapi-hooks

What problem does it solve?

OCAPI hooks provide server-side extension points that let you inject custom logic into the lifecycle of OCAPI requests, enabling augmentation, validation, or modification of API behavior without altering core platform code.

Core Features & Use Cases

• Hook types: before<HTTP_Method>, after<HTTP_Method>, and modify<HTTP_Method>Response to customize request handling and responses.
• Registration & structure: guidance for registering hooks in a cartridge via package.json and hooks.json, with recommended folder layouts and organization.
• Real-world scenarios: validate incoming requests, enrich responses with custom attributes, and trigger external integrations while maintaining transactional integrity when needed.

Quick Start

Install and register a sample OCAPI hook workflow by adding scripts under cartridge/scripts/hooks and updating hooks.json accordingly.