REST API allows to work with Targetprocess data. It can be easily used for any programming language and development platform.
There are 2 versions of the API:
REST API v.1 is the api for 'write' actions. It supports:
- all the actions (create, read, update, delete)
- XML (default) and JSON formats
More information: REST API v.1 Getting Started.
REST API v.2 is the api for 'read' actions. It supports:
- 'read' action only
- JSON format only
This version has more powerful filtering and querying possibilities compared to v.1. More information: Rest API v.2 Overview
History API allows to query the historical data. It can be used to retrieve the exact state of an entity on a particular date.
More information: What is a historical record?
Other APIs include:
- RESTful Storage: RESTful Storage
- Views menu API: Views Menu API
- Requesters Validation: Validate Requesters
- Undelete API: Undelete API
Examples of the usage of the APIs in integrations with external services:
This feature adds the ability to automatically react to a change in Targetprocess or an event in a third party service, execute custom logic, and form a pack of changes that will be made in Targetprocess as a result. Automation Rules can be triggered on:
- Update of a Targetprocess entity;
- Time interval;
- Incoming Webhook from a third-party service.
Automation Rules can be used to:
- Create or Update a Targetprocess entity;
- Send HTTP request;
Automation Rules replace the functionality of Outgoing Webhook plugin.
More information: Automation Rules Overview
Metrics feature allows you to define some computations and persist their results in Targetprocess entities. It is possible to create formulas and populate custom fields of the entities with calculated values.
More details: Metrics Overview
Webhooks can be replaced by Automation Rules. The Automation Rules have better filtering, can perform more diverse actions and have better performance in comparison to Webhooks.
Outgoing webhook plugin allows you to listen to triggers in Targetprocess entities, which will then send relevant data to external URL in real-time. Using this plugin you can create your own integrations with:
- third-party services (e.g. Slack or Zapier)
- your own service
- with Targetprocess itself
More information: Webhooks in Targetprocess.
Mashups are custom add-ins and extensions for Targetprocess. They can help you to tweak built-in features, add new controls, widgets and reports, hide redundant fields, and slightly modify existing actions and workflows. More on them: Mashups Overview.
Updated 5 months ago