v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Sync actions

Create sync action

Creates a sync action

post/api/{cloudId}/v1/syncs/{syncId}/actions

Path parameters

syncIdstring required

Id of the sync.

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 addComment or closeIssue etc.

namestring required

Name of the action.

direction'incoming' | 'outgoing' required

Direction of the action. It can be incoming or outgoing

actionGroupType'forwarding' | 'updating' | 'checkbox'

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

enabledboolean

Enabled status of the action.

propertiesobject

Action specific properties of the action.

fieldMappingsobject

The fields mapping between payload and alert fields.

Response

Returned if the request is successful

idstring

Id of the action.

namestring

Name of the action.

typestring

Type of the action.

enabledboolean

Enabled status of the action.

ordernumber float

Order of the action.

direction'incoming' | 'outgoing'

Direction of the action.

actionGroupIdstring

Id of the action group that the action belongs to.

fieldMappingsobject

Field mappings of the action.

propertiesobject

Properties of the action.