Starting October 10th, a couple of changes will be made to the CMA endpoints related to Workflows.

Workflows are a feature enabled in our Enterprise plans, so most of our users won't be affected by this change. All accounts actively using Workflows have already been notified via email about this change. If you did not receive an email, then you have nothing to worry about. 😉

Let's see how the workflow entity will change:

1
// Until October 10th:
2

3
{
4
  "type": "workflow",
5
  "id": "approval_by_editors",
6
  "attributes": {
7
    "name": "Approval by editors",
8
    "stages": [...]
9
  }
10
}
11

12
// From October 10th:
13

14
{
15
  "type": "workflow",
16
  "id": "123902133",
17
  "attributes": {
18
    "name": "Approval by editors",
19
    "api_key": "approval_by_editors",
20
    "stages": [...]
21
  }
22
}

As you can see:

• The old ID is now present in the new payload as attributes.api_key;

• The ID becomes a regular DatoCMS ID, immutable during environment forks.

Please note that it will still be possible to fetch, update and delete workflows by passing the API key in the URL, although it is suggested to use the ID.

It will be required to pass the new ID instead of the API key every time a workflow is referenced in another entity relationship (ie. when creating/updating a Model) and inside roles permission rules.