Targetprocess

The Targetprocess Developer Hub

Welcome to the Targetprocess developer hub. Here you'll find comprehensive guides and documentation to help you start working with Targetprocess as quickly as possible and support you if you get stuck. Let's jump right in!

Docs

Available fields and entities

Suggest Edits

Webhook plugin was deprecated.

Please consider using the Automation Rules feature instead. The Automation Rules feature is available in Targetprocess v3.13.0++. It is not supported for On-Site Targetprocess installations.

This is a complete list of entities and their fields that are available for usage in Targetprocess webhooks.

If you don't find a field in this list, it means it's not available.

Fields available in Templates of Webhooks only

These fields cannot be used in filters.

String fields
Number fields
Enum
  • AuthorEmail,
  • AuthorName,
  • EntityUri,
  • TargetprocessUri
  • AuthorID
  • Modification
    (Created \ Updated \ Deleted)

Fields available both in Filters and Templates of Webhooks

In templates all the fields listed below can be used without any limitations.
In the filters all the fields below can be used only if you have one entity type selected. If you have several entity types selected, only general fields would work.

Any field name can be used 'as is' which represents current state of modified entity.
When you add Previous. prefix to a field name you retrieve state the entity was in just before modification event.

Epics

String fields
Number fields
DateTime fields
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • OwnerName (TP 3.12.5+)
  • InitialEstimate,
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

Features

String fields
Number fields
DateTime fields
  • EpicName,
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • OwnerName (TP 3.12.5+)
  • EpicID,
  • InitialEstimate
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

User Stories

String fields
Number fields
DateTime fields
  • FeatureName,
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • OwnerName (TP 3.12.5+)
  • FeatureID,
  • InitialEstimate
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

Tasks

String fields
Number fields
DateTime fields
  • UserStoryName,
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • OwnerName (TP 3.12.5+)
  • UserStoryID,
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

Bugs

String fields
Number fields
DateTime fields
  • FeatureName,
  • SeverityName,
  • UserStoryName,
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • OwnerName (TP 3.12.5+)
  • FeatureID,
  • SeverityID,
  • UserStoryID
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

Test Plans

String fields
Number fields
DateTime fields
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • InitialEstimate,
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

Test Plan Runs

String fields
Number fields
DateTime fields
  • TestPlanName,
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • FailedCount,
  • NotRunCount,
  • PassedCount,
  • TestPlanID
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate

Requests

String fields
Number fields
DateTime fields
Boolean fields
Enum fields
  • RequestTypeName,
  • Custom fields,
  • Description,
  • EntityStateName,
  • EntityTypeName,
  • IterationName,
  • Name,
  • ParentName,
  • PriorityName,
  • ProjectName,
  • ReleaseName,
  • SquadIterationName,
  • TeamIterationName,
  • TeamName (one team only),
  • OwnerName (TP 3.12.5+)
  • RequestTypeID,
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • EntityStateID,
  • EntityTypeID,
  • ID,
  • IterationID,
  • LastCommentUserID,
  • LastEditorID,
  • NumericPriority,
  • OwnerID,
  • ParentID,
  • PriorityID,
  • Progress,
  • ProjectID,
  • ReleaseID,
  • TeamID (one team only),
  • SquadIterationID,
  • TeamIterationID,
  • TimeRemain,
  • TimeSpent
  • CreateDate,
  • EndDate,
  • LastCommentDate,
  • ModifyDate,
  • PlannedEndDate,
  • PlannedStartDate,
  • StartDate
  • IsPrivate,
    (Nullable)
  • IsReplied
    (Nullable)
  • SourceType
    (None \ Email \ Phone \ Internal \ External)

Comments

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
Boolean fields
  • Description,
  • GeneralName,
  • GeneralType,
  • OwnerName (TP 3.12.5+)
  • CommentID,
  • GeneralID,
  • OwnerID
  • CreateDate
  • IsPrivate,
  • IsPinned

Starting from Targetprocess 3.11.6 there is one more field available: RawDescription.
The difference between Description and RawDescription field is only in the way it handles @mentions in comments:
Description: Hi there Julia Pastushenko FirstName LastName
RawDescription: Hi there @user:julia[Julia Pastushenko] @user:login[FirstName LastName]

Projects

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
Boolean fields
  • Name,
  • Description,
  • Abbreviation,
  • EntityTypeName,
  • ProcessName.
  • Custom fields,
  • EntityStateName,
  • Color,
  • InboundMailReplyAddress,
  • ProgramOfProjectName,
  • OwnerName (TP 3.12.5+)
  • ID,
  • NumericPriority,
  • SourceControlType,
  • OwnerID,
  • LastEditorID,
  • ProcessID,
  • Progress,
  • EntityStateID,
  • EntityTypeID,
  • ProgramOfProjectID,
  • CompanyID,
  • LastCommentUserID
  • CreateDate,
  • ModifyDate,
  • StartDate,
  • EndDate,
  • PlannedStartDate,
  • PlannedEndDate,
  • LastCommentDate
  • IsActive,
  • IsProduct

Teams

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
  • Icon,
  • Abbreviation,
  • Name,
  • EntityTypeName,
  • Custom fields,
  • Description,
  • OwnerName (TP 3.12.5+)
  • ID,
  • NumericPriority,
  • OwnerID,
  • LastEditorID,
  • EntityTypeID,
  • LastCommentUserID
  • CreateDate,
  • ModifyDate,
  • LastCommentDate

Impediments

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
Boolean fields
  • Name,
  • EntityTypeName,
  • AssignableName,
  • EntityStateName,
  • PriorityName,
  • ProjectName,
  • Custom fields,
  • ResponsibleName,
  • Description,
  • OwnerName (TP 3.12.5+)
  • ID,
  • NumericPriority,
  • OwnerID,
  • LastEditorID,
  • AssignableID,
  • EntityStateID,
  • PriorityID,
  • ProjectID,
  • ResponsibleID,
  • EntityTypeID,
  • LastCommentUserID
  • CreateDate,
  • ModifyDate,
  • StartDate,
  • EndDate,
  • PlannedStartDate,
  • PlannedEndDate,
  • LastCommentDate
  • IsPrivate

Iterations

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
  • Name,
  • ParentProjectName,
  • EntityTypeName,
  • ReleaseName,
  • Custom fields,
  • Description,
  • OwnerName (TP 3.12.5+)
  • ID,
  • NumericPriority,
  • Velocity,
  • Duration,
  • ParentProjectID,
  • OwnerID,
  • LastEditorID,
  • ReleaseID,
  • EntityTypeID,
  • Progress,
  • LastCommentUserID
  • CreateDate,
  • ModifyDate,
  • StartDate,
  • EndDate,
  • LastCommentDate

Releases

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
  • Name,
  • Description,
  • EntityTypeName,
  • ProjectName (one project only),
  • Custom fields,
  • ProcessName,
  • OwnerName (TP 3.12.5+)
  • ID,
  • NumericPriority,
  • LastCommentUserID,
  • OwnerID,
  • LastEditorID,
  • ProjectID (one project only),
  • EntityTypeID,
  • Progress,
  • ProcessID
  • CreateDate,
  • ModifyDate,
  • StartDate,
  • EndDate,
  • LastCommentDate

Times

Available in Targetprocess 3.8.1+

String fields
Number fields
DateTime fields
Boolean fields
  • Description,
  • Custom fields,
  • ProjectName,
  • AssignableName,
  • RoleName
  • ID,
  • Spent,
  • Remain,
  • ProjectID,
  • UserID,
  • AssignableID,
  • RoleID
  • CreateDate,
  • SpentDate
  • Estimation

Assignments

Available in Targetprocess 3.8.1+

String fields
Number fields
  • AssignableName,
  • RoleName,
  • AssignableType
  • ID,
  • AssignableID,
  • UserID,
  • RoleID

Role Efforts

Available in Targetprocess 3.8.1+

String fields
Number fields
  • AssignableName,
  • RoleName
  • ID,
  • InitialEstimate,
  • Effort,
  • EffortCompleted,
  • EffortToDo,
  • TimeSpent,
  • TimeRemain,
  • AssignableID,
  • RoleID

Available fields and entities

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.