Alpha Description of what problems this provider handles.
Unique identifier for this provider.
Used to identify the provider in the repository and to link problems back to their source. Should be a stable, lowercase identifier using hyphens for word separation (e.g., 'email-integration', 'external-crm-sync').
The platform uses this id to set providerId when returning problems to consumers.
Human-readable title for the provider.
Should clearly identify the source of problems (e.g., 'Email Integration', 'External CRM Sync').
Retrieves a specific problem by its id.
A promise resolving to the problem if found, or undefined if no problem with that id exists.
The unique identifier of the problem within this provider.
Returns available actions for a specific problem.
Actions allow users to take action on problems (e.g., retry, dismiss, navigate to configuration). Each action wraps a command that executes when triggered.
An array of actions available for this problem. Return an empty
array [] if no actions are available.
The problem to get actions for.
Optional getReturns available actions for a selection of problems.
Bulk actions let users act on multiple problems at once (e.g., retry all failed imports in a single operation). The provider decides which actions make sense across a set of problems and constructs the command payload accordingly.
When this method is not implemented, the platform does not offer bulk actions for this provider.
An array of actions available for the selection. Return an
empty array [] if no bulk actions apply.
getBulkActions(problems: Problem[]): Action[] {
const messageIds = problems
.map(p => p.id);
if (messageIds.length === 0) {
return [];
}
const command = new BulkRetryImportCommand();
command.messageIds = messageIds;
return [
{
label: 'Retry import',
icon: 'refresh',
command: command,
},
];
}
The selected problems to get bulk actions for.
Returns the count of problems matching the query options.
Should return the total count of matching problems, not affected by pagination (limit/offset).
A promise resolving to the number of matching problems.
Optional options: ProblemQueryOptionsQuery options for filtering. Pagination options (limit/offset) should be ignored when counting.
Optional getReturns a web component descriptor for rendering custom metadata in the problem detail dialog.
The component is responsible for rendering the problem's metadata. Any properties specified in props are set on the created element.
When this method is not implemented or returns undefined, the
detail dialog renders without a metadata section.
A component descriptor, or undefined if no custom
metadata rendering is needed for this problem.
getMetadataComponent(problem: Problem): ComponentDescriptor | undefined {
if (problem.type === 'delivery-failed') {
return {
name: 'email-delivery-metadata',
props: { problem },
};
}
return undefined;
}
The problem whose metadata should be rendered.
Retrieves problems from this provider.
Implement filtering based on the provided options where supported. Unsupported filters should be silently ignored.
A promise resolving to an array of problems matching the query.
Optional options: ProblemQueryOptionsQuery options for filtering and pagination. All properties are optional. Providers should handle what they support and ignore the rest.
Returns display information for a problem status.
Display information for the status, or undefined if the status is not recognized by this provider.
The status identifier (from status).
Returns all statuses supported by this provider.
Used by the platform to render status filters and understand the provider's workflow.
An array of all statuses this provider uses. Return an empty
array [] if this provider doesn't track status.
Returns display information for a problem type.
Problem types are provider-specific identifiers (e.g., 'delivery-failed', 'connection-error'). This method provides the human-readable title, description, and icon for each type.
Display information for the type, or undefined if the type is not recognized by this provider.
The problem type identifier (from type).
Returns all problem types supported by this provider.
Used by the platform to render type filters and understand the provider's problem categories.
An array of all problem types this provider can produce.
Optional getReturns additional views to display in the problem detail dialog.
Each view appears alongside the default detail panel. The provider controls the label and rendered component for every view; the platform decides how to present them (tabs, panels, etc.).
When this method is not implemented or returns an empty array, the detail dialog renders without additional views.
An array of view descriptors. Return an empty array []
if no additional views are needed for this problem.
getViews(problem: Problem): ProblemView[] {
return [
{
id: 'raw-email',
label: 'Raw Email',
icon: 'email',
component: {
name: 'email-raw-content',
props: { problem },
},
},
{
id: 'audit-log',
label: 'Audit Log',
icon: { name: 'history', color: 'gray' },
component: {
name: 'email-audit-log',
props: { problemId: problem.id },
},
},
];
}
The problem being viewed in the detail dialog.
Interface that packages implement to provide problems to the platform.
Providers are responsible for:
The platform aggregates problems from all registered providers.
Example
Provider implementation
Example
Registering a provider
See