customize-sdk-hooks

You can add custom headers and telemetry to an SDK by implementing BeforeRequest, AfterSuccess, and AfterError hooks. These lifecycle hooks allow you to inject custom logic like header modification and telemetry capture without altering generated code each cycle.

Implement HMAC signing in SDK requests by creating a hook implementation file that adheres to the BeforeRequest interface. Register this hook in the SDK's registration file to ensure your custom signing logic executes during the request lifecycle and survives regenerations.

Yes, custom hooks require your Speakeasy-generated SDK to contain a src/hooks/ directory and a registration.ts file. You must place new hook implementations under src/hooks/ and wire them through registration.ts before regenerating the SDK with the CLI.

Yes, you can inject correlation IDs and custom authentication headers into API requests using BeforeRequest hooks. This allows you to configure custom middleware logic across multiple languages directly within the SDK lifecycle.

Yes, custom hook implementations are preserved across SDK regenerations. As long as your hooks adhere to the defined interfaces and are registered in the src/hooks/registration.ts file, they will remain intact during the request lifecycle.

The best way to capture per-operation observability data is by using AfterSuccess and AfterError hooks. These lifecycle hooks enable you to capture telemetry and transform responses during SDK usage without touching the underlying API specs.