Interface ExtensionDraft

interface ExtensionDraft {
    destination: ExtensionDestination;
    key?: string;
    timeoutInMs?: number;
    triggers: ExtensionTrigger[];
}

Properties

destination key? timeoutInMs? triggers

Properties

Readonly destination

destination: ExtensionDestination

Defines where the Extension can be reached.

Optional Readonly key

key?: string

User-defined unique identifier for the Extension.

Optional Readonly timeoutInMs

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. The maximum value is 10000 ms (10 seconds) for payment Extensions and 2000 ms (2 seconds) for all other Extensions.

This limit can be increased per Project after we review the performance impact.
Please contact our support via the [Support Portal](https://support.commercetools.com) and provide the Region, Project key, and use case.

Readonly triggers

triggers: ExtensionTrigger[]

Describes what triggers the Extension.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc