Action

Table of contents

1. Description
2. Properties

---

Description

Action is an entity which represents the destination on which Alert Notification service will send a processed event, e.g. Email, Slack, Webhook, etc.

Properties

Field	Type	Description
id?	string	An identification string which will be generated on its creation
type	string	Action’s type, e.g. STORE, EMAIL, etc
name	string	Unique name, used for identification
state	State (string)	Identifies the action’s current state, that is, if it’s currently enabled or disabled
description	string	Brief description of the action, e.g. explaining what it will be used for
properties	object<string, string>	Action specific key-value pairs describing configuration properties
fallbackAction?	string	Action to fallback to if execution of current action fails
fallbackTime?	number	Time in seconds to allow the current action to be retried before executing the fallback action. If 0, undefined or null the action will be retried for its maximum times and if still fails, then the fallback action will be executed
discardAfter?	number	Time in seconds to allow the current action to be retried before being discarded. If 0, undefined or null the action will be retried for its maximum times.
enableDeliveryStatus?	boolean	Choose to trigger delivery status event for each event matched for delivery through this action. To receive this event, subscribe to it by referring to the Delivery Status event catalog topic outlined in the SAP Alert Notification service Help Portal documentation.
labels?	string[]	Representing meaningful identifiers, which enable custom displaying & filtering capabilities

@Example:

import { State } from '@sap_oss/alert-notification-client';

const action = {
    name: 'to-my-email',
    type: 'EMAIL',
    description: 'send to my mail',
    state: State.ENABLED,
    properties: {
        destination: '<your-email>@<domain>.com'
    }
};