@gradientedge/commercetools-utils
    Preparing search index...

    Interface ExtensionDraft

    interface ExtensionDraft {
        additionalContext?: ExtensionAdditionalContextDraft;
        dependencies?: ExtensionResourceIdentifier[];
        destination: ExtensionDestination;
        expansionPaths?: string[];
        key?: string;
        timeoutInMs?: number;
        triggers: ExtensionTrigger[];
    }
    Index
    additionalContext? dependencies? destination expansionPaths? key? timeoutInMs? triggers
    additionalContext?: ExtensionAdditionalContextDraft

    Configures additional information included in the payload sent to the API Extension.

    dependencies?: ExtensionResourceIdentifier[]

    Extensions that must complete before this Extension is called, identified by id or key. Maximum 5 entries. If omitted, the Extension has no dependencies and may run concurrently with other independent Extensions.

    destination: ExtensionDestination

    Defines where the Extension can be reached.

    expansionPaths?: string[]

    Expansion paths used for reference expansion of the payload.

    Be aware of the [limits](/api/limits#api-extensions) of this feature and its [performance impact](/api/performance-tips#api-extensions).
    key?: string

    User-defined unique identifier for the Extension.

    timeoutInMs?: number

    Maximum time (in milliseconds) the Extension can respond within. If no timeout is provided, the default value is used for all types of Extensions. We recommend keeping the timeout as low as possible to avoid performance issues.

    The limit of 10000 ms (10 seconds) can be increased per Project after we review the performance impact.
Please contact the [commercetools support team](https://support.commercetools.com) and provide the Region, Project key, and use case.
    triggers: ExtensionTrigger[]

    Describes what triggers the Extension.

    Settings
    Member Visibility

    On This Page
    Properties