Change to Workflow

In January 2022, the following record types have been renamed:

Similarly, many attributes that contain the word change have also been renamed.

The sections below describe the adjustments to various parts of R-Service in more detail.

The APIs remain backward compatible until November 25, 2023 in QA, and until December 2, 2023 in Production. After this date, API endpoints and attributes containing the word ‘change’ will no longer be available. To ensure that your own API integrations continue to work after this date, please adjust them according to the instructions on this page.

Contents

Actions for API users

Refer to the sections listed below for a list of deprecations for each of the major APIs in R-Service.

For each API, there is an account setting that can be toggled to temporarily allow usage of the deprecations in your R-Service account. Once the deprecation period expires, these account settings will be removed and the listed deprecations will no longer work.

Therefore, you should migrate your API integrations as soon as possible and switch off the corresponding account settings as soon as possible to verify that your integrations still work and will continue to work once the deprecation period expires.

GraphQL API

To temporarily continue using the deprecations listed above, enable the account setting “Allow deprecated use of change in GraphQL API”.

By default, this setting is enabled in existing R-Service accounts, and disabled in new R-Service accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, the above deprecations will no longer work.

REST API

To temporarily continue using the deprecations listed above, enable the account setting “Allow deprecated use of change in REST API”.

By default, this setting is enabled in existing R-Service accounts, and disabled in new R-Service accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, the above deprecations will no longer work.

Bulk API

To temporarily continue using the deprecations listed above, enable the account setting “Allow deprecated use of change in Bulk API”.

By default, this setting is enabled in existing R-Service accounts, and disabled in new R-Service accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, the above deprecations will no longer work.

Mail API

To temporarily continue using the deprecation listed above, enable the account setting “Allow deprecated use of change in Mail API”.

By default, this setting is enabled in existing R-Service accounts, and disabled in new R-Service accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, the above deprecation will no longer work.

Webhooks API

To temporarily continue using the deprecation listed above, enable the account setting “Allow deprecated use of change in Webhooks API”.

By default, this setting is enabled in existing R-Service accounts, and disabled in new R-Service accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, the above deprecation will no longer work. The event parameter will then contain workflow.<action> when the webhook uses a change.<action> event.

Status Workflow Pending

The status ‘Change Pending’ has been renamed to ‘Workflow Pending’. Similarly, the id of the status has been renamed from change_pending to workflow_pending.

This affects the following APIs:

To temporarily continue using the id change_pending in the listed APIs, enable the account setting “Use deprecated change_pending status in API responses”.

By default, this setting is enabled in existing R-Service accounts, and disabled in new R-Service accounts. This setting is available until the end of the deprecation period. Once the deprecation period expires, workflow_pending will always be used.

Actions for the account designer of your R-Service account

For the most part, all occurrences of the word “Change” in the R-Service Service have been renamed by R-Service. However, you may still encounter the word “Change” in user-generated content of your R-Service account. In particular:

User Interface

The following adjustments have been made to the user interface (R-Service Self Service and the Specialist interface).

Renamed attributes

Note: The ‘Change manager’ field of Services has not been renamed.

Other renamings

URLs

Email templates

PDF Designs

Dashboards and reports

Automation rules

UI Extensions