GuidesAPI Reference
Back to All

Version 20190426.01

about 5 years ago by Jeremy Wilson

Today, Apr 26, 2019, we released some significant features which affect the API with endpoints and properties which have been marked for deprecation.

📘

About Deprecation

Everything as a part of this release, including the EntityLifecycle to Journey and the ExternalCustomerId to ExternalEntityType is backward compatible.

EntityLifecycle Deprecated

We will no longer be recommending the usage of the EntityLifecycle endpoints, and instead recommend that everyone use the new "Journey" endpoints, which function nearly identical to the old endpoint.

Journeys API Reference

Introducing Entity Types

With this release, we are introducing Entity Types, both internal to Chassi and external to your own system. This means that you can dynamically link any journey to any of Chassi's existing entities (Customer, Contact) and you can also link a journey to any of your own entities. Not only can you use journeys for contacts and customers, but you can track literally any type of entity, even if it is not a first-class citizen in Chassi.

The previous method of linking an external customer has been marked for deprecation and instead is now referencable using the externalEntityTypeIdentifier as customerId. In any case, the old way will still work, but we recommend that you shift your integration to begin using the new Entity Type properties of a Journey.

Entity Type API Reference
External Entity Type API Reference

Internal Entity Types
customerId
contactId

External Entity Types
customerId
contactId

We do cover the concept in general at Thinking Ahead: Integration. In the weeks ahead, we will be adding more detailed "How To" articles which will provide code samples and actual step by step instructions on how to use Entity Types.

For more information on how to use Journey Entity Types and External Entity Types, we have published additional documentation:

Entity Types
External Entity Types
Using Entities with Journeys
Searching Journeys with Entity Identifiers

Journeys for Contacts and Customer Contacts

With the introduction of Entity Types, we have enabled the ability to start and manage journeys for both Contacts and Customer Contacts in Single Customer View natively.

Changelog

  • added: Last 10 Modified Journeys for a Contact on the Contact Dashboard
  • added: View All Contact Journeys from the Contact Dashboard
  • added: Start and Manage Contact Journeys from the Contact Dashboard
  • added: Last 10 Modified Journeys for a Customer Contact on the Customer Contact Dashboard
  • added: View All Customer Contact Journeys from the Customer Contact Dashboard
  • added: Start and Manage Customer Contact Journeys from the Customer Contact Dashboard
  • improved: Deprecated EntityLifecycle API endpoint in favor of Journey endpoint
  • improved: Deprecated Journey endpoint property ExternalCustomerId in favor of ExternalEntityType customerId
  • improved: Updated Spaces functionality within Lifecycle to support searching for Journeys by Tag, Entity Type and Metadata
  • improved: Removed ExternalCustomerId from Spaces search in favor of ExternalEntityType customerId within the search UI
  • added: readme.io documentation is now generally available (GA)
  • improved: New production cluster to prepare for future blue/green cluster deployments