Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Integration actions

Update integration action

Updates an integration action. <br> <br> Permissions required: Permission to update the integration action:

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

Path parameters

integrationIdstring required

ID of the integration.

idstring required

ID of the integration action.

Request body

namestring

Name of the action.

enabledboolean

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

typeSpecificPropertiesobject

Action specific properties of the action.

fieldMappingsobject

The fields mapping between payload and alert fields.

Example request

{
  "name": "Updated action name",
  "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.

typestring

Type of the integration.

namestring

Name of the integration.

enabledboolean

Indicates whether the integration is enabled or not.

teamIdstring

ID of the team that integration belongs to.

typeSpecificPropertiesobject

Integration specific properties.