Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Integration actions

Get integration action

Returns the action of an integration. <br> <br> Permissions required: Permission to access to the integration action:

  • the user has read-only administrative right.
  • the integration's assigned team is one of the teams that the user belongs to.
get/api/{cloudId}/v1/integrations/{integrationId}/actions/{id}

Path parameters

integrationIdstring required

ID of the integration.

idstring required

ID of the integration action.

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": ""
  }
}