Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Integration actions

Create integration action

Creates an integration action.<br> <br> Permissions required: Permission to create an integration action:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.
post/api/{cloudId}/v1/integrations/{integrationId}/actions

Path parameters

integrationIdstring required

ID of the integration

Request body

typestring required

Type of the action. It can be create, close, acknowledge or addNote for incoming actions. Types of outgoing actions can be change according to integration types such as publish or sendMessage etc.

namestring required

Name of the action.

domain'alert' required

Domain of the action. It can be alert

direction'incoming' | 'outgoing' required

Direction of the action. It can be incoming or outgoing

groupType'forwarding' | 'updating' | 'checkbox'

Group type of the action. It can be forwarding, updating or checkbox. It must be provided for outgoing actions

extraFieldstring

Extra field for the action

typeSpecificPropertiesobject

Action specific properties of the action.

fieldMappingsobject

The fields mapping between payload and alert fields.

enabledboolean

This parameter is for specifying whether the integration action will be enabled or not. Defaults to false

Example request

{
  "type": "create",
  "name": "Create Alert2",
  "domain": "alert",
  "direction": "incoming",
  "filter": {
    "conditionMatchType": "match-all",
    "conditions": []
  },
  "fieldMappings": {
    "note": "",
    "description": "{{message}}",
    "source": "Email",
    "message": "{{subject}}",
    "priority": "{{priority}}",
    "tags": [],
    "alias": "",
    "details": {
      "From": "{{from_address}}"
    },
    "user": "",
    "actions": [],
    "entity": ""
  }
}

Response

Returned if the request is successful.

idstring

ID of the integration action.

typestring

Type of the integration action.

namestring

Name of the integration action.

domain'alert'

Domain of the action. It can be alert

direction'incoming' | 'outgoing'

Direction of the action. It can be incoming or outgoing

groupType'forwarding' | 'updating' | 'checkbox'

Group type of the action. It can be forwarding, updating or checkbox. It is not blank for outgoing actions

extraFieldstring

Extra field for the action

typeSpecificPropertiesobject

Action specific properties.

fieldMappingsobject

The fields mapping between payload and alert fields.

Example response

{
  "filter": {
    "conditionMatchType": "match-all",
    "conditions": []
  },
  "fieldMappings": {
    "note": "",
    "description": "{{message}}",
    "source": "Email Updated",
    "message": "{{subject}}",
    "priority": "{{priority}}",
    "tags": [],
    "alias": "",
    "details": {
      "From": "{{from_address}}"
    },
    "user": "",
    "actions": [],
    "entity": ""
  }
}