Output API: Migration guide

Table of Contents

1. Introduction

With the release of v1 of the output API support was added for post-processing using a compose script. This means a message can contain multiple inputs. This new feature comes with a new version of the API. In order to upgrade from v0 to v1 some clientside changes are required.

In this document we’ll go over the relevant changes when migrating a v0 client to the v1 version of the API.

2. Changes

2.1. Endpoint

The domain has changed from api.xribe.io to runtime.compose.platform.unifiedpost.com in order to provide more uniform domain names company-wide. Similarly, the basepath has changed from /runtime to /api to create a more uniform namespace spanning all APIs.

In order to migrate, the version component in the path needs to be changed from v0 to v1.

In summary: the base of all requests changes from https://api.xribe.io/runtime/v0/ to https://runtime.compose.platform.unifiedpost.com/api/v1/

2.2. Response

The v0 response body simply contains the UUID of the created message.

"zzzz-zzzzz-zzzzz-zzzzzzz-zzzzz"

The response body of the new v1 API returns a json structure for easier parsing and to minimize the difference between successful responses and error responses.

{
   "projectID":"xxxx-xxxxx-xxxxx-xxxxxxx-xxxxx",
   "environmentID":"yyyy-yyyyy-yyyyy-yyyyyyy-yyyyy",
   "messageID":"zzzz-zzzzz-zzzzz-zzzzzzz-zzzzz",
   "href":"https://runtime.compose.platform.unifiedpost.com/api/v1/message/zzzz-zzzzz-zzzzz-zzzzzzz-zzzzz?projectID=xxxx-xxxxx-xxxxx-xxxxxxx-xxxxx&environmentID=yyyy-yyyyy-yyyyy-yyyyyyy-yyyyy"
}

2.3. Callback

The status you’ll receive in the callback is now DeliverableGenerated instead of DeliverableDelivered. If you’re testing for that value to detect generation was succesful, you’ll want to change that. The status will now be changed to DeliverableDelivered only after a successfull callback when a webhook is specified as deliveryParameter.

Additionally, support for multiple inputs by v1 means that the callback must be able to return multiple outputs. The type of the output property in the deliverable is therefore changed to an array. To match outputs with inputs an id property has been added tot he url as well. Requests ported from v0 will only contain a single input, so all callbacks will contain an output array with a single object with a generated id and the value of the v0 output property as url.

Callback and Deliverable structures will now include a version property that is set to 1.

2.4. Email Properties

When requesting email output, the subject and addresses that can be specified in the template and that were returned as outputProperties are now returned as an additional output element. The id of the output element is the id of the accompanying html output appended with /properties.

So instead of a callback with outputProperties,

{
   "account":"acme",
   "creator":"acme\\jdoe",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "deliverableID":"d62199e6-eaba-4ef4-ae19-fa035c4d826f",
   "messageID":"e3bd6033-d7cd-4b88-8559-d69a99283ddb",
   "eventType":"DeliverableDelivered",
   "created":"2021-07-13T09:50:06.257Z",
   "properties":{
      "tracking":"1234-5678"
   },
   "output":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/output/d62199e6-eaba-4ef4-ae19-fa035c4d826f.html?X-Amz-Algorithm=...",
   "template":"showcase/webtemplate/HelloWorld.sdt",
   "originalTemplateId":"a1959e90-6d3c-4869-a606-2568ea0438ce",
   "outputProperties":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/output/d62199e6-eaba-4ef4-ae19-fa035c4d826f.json?X-Amz-Algorithm=..."
}

an additional output element is returned with an id ending with /properties. An equivalent change applies to the deliverable.

{
   "account":"acme",
   "creator":"acme\\jdoe",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "deliverableID":"5fd2f7e0-bacf-45c4-869a-8eb71f0c2056",
   "messageID":"6ec7c70d-34a3-4c4b-82b8-1c472de04f03",
   "eventType":"DeliverableGenerated",
   "created":"2021-07-13T09:51:06.195Z",
   "properties":{
      "tracking":"1234-5678"
   },
   "output":[
      {
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/output/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056.html?X-Amz-Algorithm=..."
      },
      {
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590/properties",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/output/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056.json?X-Amz-Algorithm=..."
      }
   ],
   "version":1,
   "template":"showcase/webtemplate/HelloWorld.sdt",
   "originalTemplateId":"8416e2c5-6fef-4868-987e-78fe1653f590"
}

2.5. Input

Version 1 of the API added functionality to post-process documents, including operations involving multiple documents like appending or overlaying. To allow multiple documents, the input property now accepts an array. In order to facilitate a smooth migration, a single element is still accepted, but when retrieving such a message using the GET API on /v1/message you’ll notice that this has been converted into an array containing a single input.

Note that messages POSTed to the v0 endpoint can be retrieved with either the v0 or v1 endpoint, but that messages POSTed to the v1 endpoint can only be retrieved from the v1 endpoint. If you try to retrieve a message created with a POST to /v0/message using a GET to /v1/message, a 404 response code will be returned.

2.6. Deliverable

The support for multiple inputs supported by v1 means that fields associated with the output rather than the message are pushed down to the output elements in the array. This is the case for pageCount, properties and outputParameters.

3. Example

We’ll show a typical interaction with the API and highlight the differences.

3.1. Message Request

Client interaction typically starts with POSTing a message request.

3.1.1. v0

POST to https://api.xribe.io/runtime/v0/message

{
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "outputParameters":{
      "type":"email"
   },
   "properties":{
      "tracking":"1234-5678"
   },
   "deliveryParameters":{
      "webhookParameters":{
         "generated":{
            "endpoint":"https://8ec0d9b7a813.ngrok.io"
         }
      }
   },
   "input":{
      "ref":"showcase/webtemplate/HelloWorld.sdt"
   },
   "data":{
      "foo":"bar"
   }
}

Response:

"e3bd6033-d7cd-4b88-8559-d69a99283ddb"

3.1.2. v1

POST to https://runtime.compose.platform.unifiedpost.com/api/v1/message

The Endpoint has changed 
{
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "outputParameters":{
      "type":"email"
   },
   "deliveryParameters":{
      "webhookParameters":{
         "generated":{
            "endpoint":"https://8ec0d9b7a813.ngrok.io"
         }
      }
   },
   "properties":{
      "tracking":"1234-5678"
   },
   "input":{
      "ref":"showcase/webtemplate/HelloWorld.sdt"
   },
   "data":{
      "foo":"bar"
   }
}

Response:

{
   "projectID": "dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID": "b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "messageID": "6ec7c70d-34a3-4c4b-82b8-1c472de04f03",
   "href": "https://runtime.tst.compose.platform.unifiedpost.com/api/v1/message/6ec7c70d-34a3-4c4b-82b8-1c472de04f03?projectID=dcb398ba-1b8c-4afd-85fd-a5905e5f42c5&environmentID=b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f"
}
The Response has changed

3.2. Callback

3.2.1. v0

{
   "account":"acme",
   "creator":"acme\\jdoe",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "deliverableID":"d62199e6-eaba-4ef4-ae19-fa035c4d826f",
   "messageID":"e3bd6033-d7cd-4b88-8559-d69a99283ddb",
   "eventType":"DeliverableDelivered",
   "created":"2021-07-13T09:50:06.257Z",
   "properties":{
      "tracking":"1234-5678"
   },
   "output":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/output/d62199e6-eaba-4ef4-ae19-fa035c4d826f.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5WOFND6M2%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095006Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAIaCWV1LXdlc3QtMSJHMEUCIEwJHHyuMPzhB1se6GLK%2BTiklKcBXYsYIjmt3Byc%2BrlHAiEA9QfIFDZc37ROYmNLwOz6pMEIFWj1P6iTirz2IW8w%2FwIqsAII6%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgwxMzYxOTUwNzQ0OTEiDB2PLqFxkSZUt3VgciqEAuEqdPMhtetSG9uUzZm9CeyFpoSrnVOZcgXNwxcZNjziVlzHJRgqqGJdcRJHKjNFbRl%2BUi26bd51fS8RXPGBEWCN3uMuUA9sdA%2FS0lbco5ajuP1MxMWv9avDs8h7Vgp0g%2BWRcEB2zNtB8U5P%2FPyTjghHOlr2uujqqsitsX2uvKKZvtK50Xbo80iQR%2BysarSAa%2FhlHoQ%2B2h%2BZF1DgdvASJuXKa0kR2zOGUYvW4q0Ks5%2Bb70O4%2Fk3mCBxSSEQ9PUScHr3Xiroa5Yr6XpYqpO264PTVam8XJy51xds%2BarZAhzqrsxt%2FjXp0zMF2wg%2BjlOly5Wo9RKqB6etOyk5908V%2FPHCuMCemMKO8tYcGOpoB1Bgri50pwlbjOE2dRMkxGnnAuOqk7RjYZq7%2FYYfmL9L9uWeTqMWh6ZQd8nsFLf5ltQGFNi3Ndw8W1gLl%2B9RTq7vmecn%2BPBQhBa44X3W53Olh5Q7ePeObTocx41T94BZgpKzYcnfjWzod6qQe3ow90pmTF%2BwWBctwO541WhQu5RXOIbEv0kM%2B4B%2BQELvKKPgXBGu4l0BtcTQuYg%3D%3D&X-Amz-Signature=839387e71f3c96185da029fcdaf06e63248d5f03dcb884d2dd29d0e17859833a&X-Amz-SignedHeaders=host",
   "template": "showcase/webtemplate/HelloWorld.sdt",
   "outputProperties":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/output/d62199e6-eaba-4ef4-ae19-fa035c4d826f.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5WOFND6M2%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095006Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAIaCWV1LXdlc3QtMSJHMEUCIEwJHHyuMPzhB1se6GLK%2BTiklKcBXYsYIjmt3Byc%2BrlHAiEA9QfIFDZc37ROYmNLwOz6pMEIFWj1P6iTirz2IW8w%2FwIqsAII6%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgwxMzYxOTUwNzQ0OTEiDB2PLqFxkSZUt3VgciqEAuEqdPMhtetSG9uUzZm9CeyFpoSrnVOZcgXNwxcZNjziVlzHJRgqqGJdcRJHKjNFbRl%2BUi26bd51fS8RXPGBEWCN3uMuUA9sdA%2FS0lbco5ajuP1MxMWv9avDs8h7Vgp0g%2BWRcEB2zNtB8U5P%2FPyTjghHOlr2uujqqsitsX2uvKKZvtK50Xbo80iQR%2BysarSAa%2FhlHoQ%2B2h%2BZF1DgdvASJuXKa0kR2zOGUYvW4q0Ks5%2Bb70O4%2Fk3mCBxSSEQ9PUScHr3Xiroa5Yr6XpYqpO264PTVam8XJy51xds%2BarZAhzqrsxt%2FjXp0zMF2wg%2BjlOly5Wo9RKqB6etOyk5908V%2FPHCuMCemMKO8tYcGOpoB1Bgri50pwlbjOE2dRMkxGnnAuOqk7RjYZq7%2FYYfmL9L9uWeTqMWh6ZQd8nsFLf5ltQGFNi3Ndw8W1gLl%2B9RTq7vmecn%2BPBQhBa44X3W53Olh5Q7ePeObTocx41T94BZgpKzYcnfjWzod6qQe3ow90pmTF%2BwWBctwO541WhQu5RXOIbEv0kM%2B4B%2BQELvKKPgXBGu4l0BtcTQuYg%3D%3D&X-Amz-Signature=6ca797de6111c52944ed52908b6477c06cd0d08b77887068dc9983df15a4116a&X-Amz-SignedHeaders=host"
}

3.2.2. v1

{
   "account":"acme",
   "creator":"acme\\jdoe",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "deliverableID":"5fd2f7e0-bacf-45c4-869a-8eb71f0c2056",
   "messageID":"6ec7c70d-34a3-4c4b-82b8-1c472de04f03",
   "eventType":"DeliverableGenerated",
   "created":"2021-07-13T09:51:06.195Z",
   "properties":{
      "tracking":"1234-5678"
   },
   "output":[
      {
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/output/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5WOFND6M2%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095106Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAIaCWV1LXdlc3QtMSJHMEUCIEwJHHyuMPzhB1se6GLK%2BTiklKcBXYsYIjmt3Byc%2BrlHAiEA9QfIFDZc37ROYmNLwOz6pMEIFWj1P6iTirz2IW8w%2FwIqsAII6%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgwxMzYxOTUwNzQ0OTEiDB2PLqFxkSZUt3VgciqEAuEqdPMhtetSG9uUzZm9CeyFpoSrnVOZcgXNwxcZNjziVlzHJRgqqGJdcRJHKjNFbRl%2BUi26bd51fS8RXPGBEWCN3uMuUA9sdA%2FS0lbco5ajuP1MxMWv9avDs8h7Vgp0g%2BWRcEB2zNtB8U5P%2FPyTjghHOlr2uujqqsitsX2uvKKZvtK50Xbo80iQR%2BysarSAa%2FhlHoQ%2B2h%2BZF1DgdvASJuXKa0kR2zOGUYvW4q0Ks5%2Bb70O4%2Fk3mCBxSSEQ9PUScHr3Xiroa5Yr6XpYqpO264PTVam8XJy51xds%2BarZAhzqrsxt%2FjXp0zMF2wg%2BjlOly5Wo9RKqB6etOyk5908V%2FPHCuMCemMKO8tYcGOpoB1Bgri50pwlbjOE2dRMkxGnnAuOqk7RjYZq7%2FYYfmL9L9uWeTqMWh6ZQd8nsFLf5ltQGFNi3Ndw8W1gLl%2B9RTq7vmecn%2BPBQhBa44X3W53Olh5Q7ePeObTocx41T94BZgpKzYcnfjWzod6qQe3ow90pmTF%2BwWBctwO541WhQu5RXOIbEv0kM%2B4B%2BQELvKKPgXBGu4l0BtcTQuYg%3D%3D&X-Amz-Signature=5dca72c6ecb8980a134c6c9f2cb66928e6d5a035ad803aaa7d514bbe4da77ac9&X-Amz-SignedHeaders=host"
      },
      {
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590/properties",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/output/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5WOFND6M2%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095106Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAIaCWV1LXdlc3QtMSJHMEUCIEwJHHyuMPzhB1se6GLK%2BTiklKcBXYsYIjmt3Byc%2BrlHAiEA9QfIFDZc37ROYmNLwOz6pMEIFWj1P6iTirz2IW8w%2FwIqsAII6%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgwxMzYxOTUwNzQ0OTEiDB2PLqFxkSZUt3VgciqEAuEqdPMhtetSG9uUzZm9CeyFpoSrnVOZcgXNwxcZNjziVlzHJRgqqGJdcRJHKjNFbRl%2BUi26bd51fS8RXPGBEWCN3uMuUA9sdA%2FS0lbco5ajuP1MxMWv9avDs8h7Vgp0g%2BWRcEB2zNtB8U5P%2FPyTjghHOlr2uujqqsitsX2uvKKZvtK50Xbo80iQR%2BysarSAa%2FhlHoQ%2B2h%2BZF1DgdvASJuXKa0kR2zOGUYvW4q0Ks5%2Bb70O4%2Fk3mCBxSSEQ9PUScHr3Xiroa5Yr6XpYqpO264PTVam8XJy51xds%2BarZAhzqrsxt%2FjXp0zMF2wg%2BjlOly5Wo9RKqB6etOyk5908V%2FPHCuMCemMKO8tYcGOpoB1Bgri50pwlbjOE2dRMkxGnnAuOqk7RjYZq7%2FYYfmL9L9uWeTqMWh6ZQd8nsFLf5ltQGFNi3Ndw8W1gLl%2B9RTq7vmecn%2BPBQhBa44X3W53Olh5Q7ePeObTocx41T94BZgpKzYcnfjWzod6qQe3ow90pmTF%2BwWBctwO541WhQu5RXOIbEv0kM%2B4B%2BQELvKKPgXBGu4l0BtcTQuYg%3D%3D&X-Amz-Signature=8e62d69a920865995042b7fc81853716e03e8022a0c06292ccbe2a366ee4e573&X-Amz-SignedHeaders=host"
      }
   ],
   "version":1
}
The Callback has changed; the eventType is now DeliverableGenerated and the output value is now moved to the url property of the only element in the output array. Also note the change in Email Properties

3.3. Get Message

3.3.1. v0

GET of https://api.xribe.io/runtime/v0/message/e3bd6033-d7cd-4b88-8559-d69a99283ddb?projectID=dcb398ba-1b8c-4afd-85fd-a5905e5f42c5&environmentID=b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f

Response:

{
   "id":"e3bd6033-d7cd-4b88-8559-d69a99283ddb",
   "properties":{
      "tracking":"1234-5678"
   },
   "status":"delivered",
   "outputParameters":{
      "type":"email"
   },
   "account":"acme",
   "creator":"jdoe",
   "created":"2021-07-13T09:50:06.042Z",
   "modified":"2021-07-13T09:50:06.042Z",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "deliverableID":"d62199e6-eaba-4ef4-ae19-fa035c4d826f",
   "deliveryParameters":{
      "webhookParameters":{
         "generated":{
            "endpoint":"https://8ec0d9b7a813.ngrok.io"
         }
      }
   },
   "data":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/topleveldata.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5RN5T2YMK%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095108Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAEaCWV1LXdlc3QtMSJGMEQCIC4XdqcIdldpqqAgfsZ42CZ58%2BL14hxnJ%2BVR%2FNpNC8MGAiBMhxOcGBb3eMUjWe5aZ%2FSEPDy6Zhlyd8u4pWd75390bCqsAgjp%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDEzNjE5NTA3NDQ5MSIML%2Fhbv88ulWdvCjThKoACnu8ymZZ%2ByFHD%2Bl2medOA6VLFLchkl7a4MYz9vFUCoqA1D3vBVLR5RiXZ6FPWEIKIowc0qRq2CyLU3zFtqnU5vJgVtCBb%2FidFc%2BqnigFBGgX1vNWUdDLDhZDXIhL5XfRg2cQqa8IrR6nm1m%2FkkpYoSHz9TV5YzlI5T8WkZvzdZmb0lmRf5hXJsfs2%2Fv8%2BFmUqqg2nxeXlwpl8wo4D0j0b54lBV8bONZKcKZchbVWUw%2BiLsUT9LsCBZjO9fXkpR6Wga%2FM2tZXgGiiStUTuAOsWSmcDbUFpFPB7ZGCCGT7FOgOaI05U0%2BbFqjxEBnAWcFNfUlujA7s7QnpJtIhtBJu5rjCImLWHBjqbAfHVgtspMb0ollz4HfdBpGnqoo0GhV9XwENimh%2BIg6ZvKmIL6azom%2F1qO3iZRyJR3cJkofl5QqpDJO9WmxT1BLs2tBdrtDZcri6Qpj9Pip0A5i5kZo%2BFGZsg1HGqR7ng0g5DmWsLeAuYF2FwX%2BI8ftYCYeQRW7Fb9ATJiFqecu0SOjJXSuK2ksohUyEAPk3amg3rrH1TMmkx12CG&X-Amz-Signature=64f125fe9bd4fe984f8f22f52d3f24ba67f477f71ec66d5b2cccb545e1603354&X-Amz-SignedHeaders=host",
   "input":{
      "ref":"showcase/webtemplate/HelloWorld.sdt",
      "storage":"resource",
      "id":"a1959e90-6d3c-4869-a606-2568ea0438ce",
      "type":"template"
   }
}

3.3.2. v1

GET of https://runtime.compose.platform.unifiedpost.com/api/v1/message/6ec7c70d-34a3-4c4b-82b8-1c472de04f03?projectID=dcb398ba-1b8c-4afd-85fd-a5905e5f42c5&environmentID=b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f

The Endpoint has changed

Response:

{
   "id":"6ec7c70d-34a3-4c4b-82b8-1c472de04f03",
   "properties":{
      "tracking":"1234-5678"
   },
   "status":"delivered",
   "account":"acme",
   "creator":"jdoe",
   "created":"2021-07-13T09:51:06.012Z",
   "modified":"2021-07-13T09:51:06.012Z",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "deliverableID":"5fd2f7e0-bacf-45c4-869a-8eb71f0c2056",
   "deliveryParameters":{
      "webhookParameters":{
         "generated":{
            "endpoint":"https://8ec0d9b7a813.ngrok.io"
         }
      }
   },
   "data":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/topleveldata.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5RN5T2YMK%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095108Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAEaCWV1LXdlc3QtMSJGMEQCIC4XdqcIdldpqqAgfsZ42CZ58%2BL14hxnJ%2BVR%2FNpNC8MGAiBMhxOcGBb3eMUjWe5aZ%2FSEPDy6Zhlyd8u4pWd75390bCqsAgjp%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDEzNjE5NTA3NDQ5MSIML%2Fhbv88ulWdvCjThKoACnu8ymZZ%2ByFHD%2Bl2medOA6VLFLchkl7a4MYz9vFUCoqA1D3vBVLR5RiXZ6FPWEIKIowc0qRq2CyLU3zFtqnU5vJgVtCBb%2FidFc%2BqnigFBGgX1vNWUdDLDhZDXIhL5XfRg2cQqa8IrR6nm1m%2FkkpYoSHz9TV5YzlI5T8WkZvzdZmb0lmRf5hXJsfs2%2Fv8%2BFmUqqg2nxeXlwpl8wo4D0j0b54lBV8bONZKcKZchbVWUw%2BiLsUT9LsCBZjO9fXkpR6Wga%2FM2tZXgGiiStUTuAOsWSmcDbUFpFPB7ZGCCGT7FOgOaI05U0%2BbFqjxEBnAWcFNfUlujA7s7QnpJtIhtBJu5rjCImLWHBjqbAfHVgtspMb0ollz4HfdBpGnqoo0GhV9XwENimh%2BIg6ZvKmIL6azom%2F1qO3iZRyJR3cJkofl5QqpDJO9WmxT1BLs2tBdrtDZcri6Qpj9Pip0A5i5kZo%2BFGZsg1HGqR7ng0g5DmWsLeAuYF2FwX%2BI8ftYCYeQRW7Fb9ATJiFqecu0SOjJXSuK2ksohUyEAPk3amg3rrH1TMmkx12CG&X-Amz-Signature=64f125fe9bd4fe984f8f22f52d3f24ba67f477f71ec66d5b2cccb545e1603354&X-Amz-SignedHeaders=host",
   "input":[
      {
         "ref":"showcase/webtemplate/HelloWorld.sdt",
         "storage":"resource",
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590",
         "type":"template",
         "outputParameters":{
            "type":"email"
         }
      }
   ]
}
The Input has changed; it is an array now.

3.4. Get Deliverable

3.4.1. v0

GET of https://api.xribe.io/runtime/v0/deliverable/d62199e6-eaba-4ef4-ae19-fa035c4d826f?projectID=dcb398ba-1b8c-4afd-85fd-a5905e5f42c5&environmentID=b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f

{
   "id":"d62199e6-eaba-4ef4-ae19-fa035c4d826f",
   "account":"acme",
   "creator":"acme\\jdoe",
   "created":"2021-07-13T09:50:06.489Z",
   "modified":"2021-07-13T09:50:06.489Z",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "pageCount":1,
   "properties":{
      "tracking":"1234-5678"
   },
   "deliveryParameters":{
      "webhookParameters":{
         "generated":{
            "endpoint":"https://8ec0d9b7a813.ngrok.io"
         }
      }
   },
   "messageID":"e3bd6033-d7cd-4b88-8559-d69a99283ddb",
   "status":"delivered",
   "outputParameters":{
      "type":"email"
   },
   "history":[
      {
         "severity":"info",
         "message":"Changed status to created",
         "created":"2021-07-13T09:50:06.489Z"
      },
      {
         "severity":"info",
         "message":"Changed status to generating",
         "created":"2021-07-13T09:50:06.230Z"
      },
      {
         "severity":"info",
         "message":"Changed status to generated for template 'showcase/webtemplate/HelloWorld.sdt'",
         "created":"2021-07-13T09:50:06.342Z"
      },
      {
         "severity":"info",
         "message":"Changed status to delivering",
         "created":"2021-07-13T09:50:06.486Z"
      },
      {
         "severity":"info",
         "message":"Changed status to delivered",
         "created":"2021-07-13T09:50:08.002Z"
      }
   ],
   "output":[
      {
         "type":"primary",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/output/d62199e6-eaba-4ef4-ae19-fa035c4d826f.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5SKIZWNMQ%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T101259Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAIaCWV1LXdlc3QtMSJGMEQCIGlvggVEnroLMqWT6gAVCDOMIrGtPPuMaQ0QrEmDQefRAiBrqY6MMRUvEHxay0uRG9qpNP3QA8dttgK5pF9%2F1LIfLSqsAgjr%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDEzNjE5NTA3NDQ5MSIMXpgD%2BDwWOO0eS8YSKoACdPL2gvtmef8ylogQvcwmXoLQvq9CNf4DU%2F7kEeT7YbXIB4qV0RwrAEniVjpbIK9m94Xi37RRTOZIn7t9zW8xL%2FjAiS5KOjz09zToUJE7sc%2BNtkVdzYmPtcMKDB5uEyjrfx8vLnRRpLd8cym5rJFOwVVbvvdiBh%2FkNBnIuICgZHwx%2BRzlOSvxxV%2BgqtIKw0GAfmcmJpdbsmOQBm4cmwF8Pz%2BKlncp6QxrLYt2N7JZqMMu4sIsgJaFfmuTk0DXDB%2ByLFtLdsmum6a3Ilh%2FT9VgazzmGUM8i9Zh4sRb549K18%2FgYp7BojebU%2F%2By3JLmcI%2BPOM0n32ZlUuemJSqH9sRaUzDgy7WHBjqbAb3qAFOzIYUhTtNKuGf%2FE0C9lq3BpxZN0NXmeNt4R9uYCggmC5vWWNdGpJtWH1rzUn%2BCegmOUkueoY1BAG3JlVqdTu%2Fnz4p8uC7KjSXth9TbhjUypO0BoHZ5jNGA%2BgyR5YMBQacJXuHCwdTad3ynPogeUp%2FQeDrPZ5UZkk%2BvBSrBbhRfUYwGK8qcVbu9OgWblIq5U4xibUZYzplO&X-Amz-Signature=689f62826832bb3aa91c28710a4c87c708b96d467e4034fe18797a680c3e85ea&X-Amz-SignedHeaders=host"
      },
      {
         "type":"properties",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/e3bd6033-d7cd-4b88-8559-d69a99283ddb/output/d62199e6-eaba-4ef4-ae19-fa035c4d826f.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5SKIZWNMQ%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T101259Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAIaCWV1LXdlc3QtMSJGMEQCIGlvggVEnroLMqWT6gAVCDOMIrGtPPuMaQ0QrEmDQefRAiBrqY6MMRUvEHxay0uRG9qpNP3QA8dttgK5pF9%2F1LIfLSqsAgjr%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDEzNjE5NTA3NDQ5MSIMXpgD%2BDwWOO0eS8YSKoACdPL2gvtmef8ylogQvcwmXoLQvq9CNf4DU%2F7kEeT7YbXIB4qV0RwrAEniVjpbIK9m94Xi37RRTOZIn7t9zW8xL%2FjAiS5KOjz09zToUJE7sc%2BNtkVdzYmPtcMKDB5uEyjrfx8vLnRRpLd8cym5rJFOwVVbvvdiBh%2FkNBnIuICgZHwx%2BRzlOSvxxV%2BgqtIKw0GAfmcmJpdbsmOQBm4cmwF8Pz%2BKlncp6QxrLYt2N7JZqMMu4sIsgJaFfmuTk0DXDB%2ByLFtLdsmum6a3Ilh%2FT9VgazzmGUM8i9Zh4sRb549K18%2FgYp7BojebU%2F%2By3JLmcI%2BPOM0n32ZlUuemJSqH9sRaUzDgy7WHBjqbAb3qAFOzIYUhTtNKuGf%2FE0C9lq3BpxZN0NXmeNt4R9uYCggmC5vWWNdGpJtWH1rzUn%2BCegmOUkueoY1BAG3JlVqdTu%2Fnz4p8uC7KjSXth9TbhjUypO0BoHZ5jNGA%2BgyR5YMBQacJXuHCwdTad3ynPogeUp%2FQeDrPZ5UZkk%2BvBSrBbhRfUYwGK8qcVbu9OgWblIq5U4xibUZYzplO&X-Amz-Signature=d9289995e6857a8a2c5eb29d08300af6f5026f1d0aa8987ace663bdcb4b19f33&X-Amz-SignedHeaders=host"
      }
   ]
}

3.4.2. v1

GET of https://runtime.compose.platform.unifiedpost.com/api/v1/deliverable/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056?projectID=dcb398ba-1b8c-4afd-85fd-a5905e5f42c5&environmentID=b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f

The Endpoint has changed 
{
   "id":"5fd2f7e0-bacf-45c4-869a-8eb71f0c2056",
   "account":"acme",
   "creator":"acme\\jdoe",
   "created":"2021-07-13T09:51:06.373Z",
   "modified":"2021-07-13T09:51:06.373Z",
   "projectID":"dcb398ba-1b8c-4afd-85fd-a5905e5f42c5",
   "environmentID":"b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f",
   "pageCount":1,
   "properties":{
      "tracking":"1234-5678"
   },
   "deliveryParameters":{
      "webhookParameters":{
         "generated":{
            "endpoint":"https://8ec0d9b7a813.ngrok.io"
         }
      }
   },
   "messageID":"6ec7c70d-34a3-4c4b-82b8-1c472de04f03",
   "status":"delivered",
   "history":[
      {
         "severity":"info",
         "message":"Changed status to created",
         "created":"2021-07-13T09:51:06.373Z"
      },
      {
         "severity":"info",
         "message":"Changed status to generating",
         "created":"2021-07-13T09:51:06.175Z"
      },
      {
         "severity":"info",
         "message":"Changed status to generated for template 'showcase/webtemplate/HelloWorld.sdt'",
         "created":"2021-07-13T09:51:06.287Z"
      },
      {
         "severity":"info",
         "message":"Changed status to delivering",
         "created":"2021-07-13T09:51:06.371Z"
      },
      {
         "severity":"info",
         "message":"Changed status to delivered",
         "created":"2021-07-13T09:51:07.805Z"
      }
   ],
   "output":[
      {
         "pageCount":1,
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590",
         "type":"primary",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/output/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5RN5T2YMK%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095111Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAEaCWV1LXdlc3QtMSJGMEQCIC4XdqcIdldpqqAgfsZ42CZ58%2BL14hxnJ%2BVR%2FNpNC8MGAiBMhxOcGBb3eMUjWe5aZ%2FSEPDy6Zhlyd8u4pWd75390bCqsAgjp%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDEzNjE5NTA3NDQ5MSIML%2Fhbv88ulWdvCjThKoACnu8ymZZ%2ByFHD%2Bl2medOA6VLFLchkl7a4MYz9vFUCoqA1D3vBVLR5RiXZ6FPWEIKIowc0qRq2CyLU3zFtqnU5vJgVtCBb%2FidFc%2BqnigFBGgX1vNWUdDLDhZDXIhL5XfRg2cQqa8IrR6nm1m%2FkkpYoSHz9TV5YzlI5T8WkZvzdZmb0lmRf5hXJsfs2%2Fv8%2BFmUqqg2nxeXlwpl8wo4D0j0b54lBV8bONZKcKZchbVWUw%2BiLsUT9LsCBZjO9fXkpR6Wga%2FM2tZXgGiiStUTuAOsWSmcDbUFpFPB7ZGCCGT7FOgOaI05U0%2BbFqjxEBnAWcFNfUlujA7s7QnpJtIhtBJu5rjCImLWHBjqbAfHVgtspMb0ollz4HfdBpGnqoo0GhV9XwENimh%2BIg6ZvKmIL6azom%2F1qO3iZRyJR3cJkofl5QqpDJO9WmxT1BLs2tBdrtDZcri6Qpj9Pip0A5i5kZo%2BFGZsg1HGqR7ng0g5DmWsLeAuYF2FwX%2BI8ftYCYeQRW7Fb9ATJiFqecu0SOjJXSuK2ksohUyEAPk3amg3rrH1TMmkx12CG&X-Amz-Signature=b6c14caabe8c8311d4b14916aa3ed316a979a44ed9f31f4d4e27f21119acf868&X-Amz-SignedHeaders=host"
      },
      {
         "pageCount":1,
         "id":"8416e2c5-6fef-4868-987e-78fe1653f590/properties",
         "type":"primary",
         "url":"https://inventiveproduction-updc-composition.s3.eu-west-1.amazonaws.com/acme/dcb398ba-1b8c-4afd-85fd-a5905e5f42c5/b4e0d9b7-16c4-4da3-b9b3-4ae3b52f5c8f/6ec7c70d-34a3-4c4b-82b8-1c472de04f03/output/5fd2f7e0-bacf-45c4-869a-8eb71f0c2056.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAR7NO35G5RN5T2YMK%2F20210713%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210713T095111Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAEaCWV1LXdlc3QtMSJGMEQCIC4XdqcIdldpqqAgfsZ42CZ58%2BL14hxnJ%2BVR%2FNpNC8MGAiBMhxOcGBb3eMUjWe5aZ%2FSEPDy6Zhlyd8u4pWd75390bCqsAgjp%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDEzNjE5NTA3NDQ5MSIML%2Fhbv88ulWdvCjThKoACnu8ymZZ%2ByFHD%2Bl2medOA6VLFLchkl7a4MYz9vFUCoqA1D3vBVLR5RiXZ6FPWEIKIowc0qRq2CyLU3zFtqnU5vJgVtCBb%2FidFc%2BqnigFBGgX1vNWUdDLDhZDXIhL5XfRg2cQqa8IrR6nm1m%2FkkpYoSHz9TV5YzlI5T8WkZvzdZmb0lmRf5hXJsfs2%2Fv8%2BFmUqqg2nxeXlwpl8wo4D0j0b54lBV8bONZKcKZchbVWUw%2BiLsUT9LsCBZjO9fXkpR6Wga%2FM2tZXgGiiStUTuAOsWSmcDbUFpFPB7ZGCCGT7FOgOaI05U0%2BbFqjxEBnAWcFNfUlujA7s7QnpJtIhtBJu5rjCImLWHBjqbAfHVgtspMb0ollz4HfdBpGnqoo0GhV9XwENimh%2BIg6ZvKmIL6azom%2F1qO3iZRyJR3cJkofl5QqpDJO9WmxT1BLs2tBdrtDZcri6Qpj9Pip0A5i5kZo%2BFGZsg1HGqR7ng0g5DmWsLeAuYF2FwX%2BI8ftYCYeQRW7Fb9ATJiFqecu0SOjJXSuK2ksohUyEAPk3amg3rrH1TMmkx12CG&X-Amz-Signature=0f3d0ee50f0a41cee4d24a6cbe9fada447ad569256537249bc6814f77562b8a7&X-Amz-SignedHeaders=host"
      }
   ]
}
The Deliverable has changed. In case email output is requested, the Email Properties are different as well.

Comments or suggestions?
Tell us here.

If you have any suggestions or comments about this guide, please send us an email using this form.