API Reference

Create Journey Application

post
https://sandbox.alloy.co/v1/journeys//applications

Create a journey application for one or more entities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Token associated with your Journey

Query Params
string
enum

If this value is true, each event of type completed_evaluation in the array at response._embedded._events includes the full evaluation response.

Allowed:
string

A comma separated list of fields to obfuscate in the full evaluation response (only relevant within the completed_evaluation type events, and provided the query parameter fullData is also set to true). For example, if hideFields=document_ssn, then "document_ssn": "123456789" would be returned as "document_ssn": "*********". This obfuscation will apply to the supplied, formatted, and meta objects in the full evaluation response, including inside nested objects within those objects.

Body Params
entities
array
required

List of entities to be processed in this Application.

entities*
string

Optional, but if you have an identifier in your system that is unique and that you would like to tie to an Application in a 1:1 relationship, you can include it here. This field will not update the Entity Group object.

string

Optional, but if you have an identifier in your system that refers to an application or an entire account, and you would like to associate it with one or more Journey Applications, you can include it here. We also have a number of endpoints that allow you to reference a Journey Application by external application id instead of by Journey Application token when retrieving, rerunning or updating the Application. Supported characters are: a-zA-Z0-9_-

boolean
Defaults to false

If this value is true, additional entities can be sent by using the PUT endpoint that updates a Journey Application.

The Journey Application will not complete until the parameter has_finished_sending_additional_entities is sent with the value true to the PUT endpoint.

application_meta
object

Optional, allows to provide additional metadata applied to all entities in the Application.

string

Optional, but if you wish to associate the entities within this application with an existing entity group or create a new entity group with this identifier, you can include it here.

For more information on entity groups, visit our guide: https://developer.alloy.com/public/docs/onboarding-with-entity-groups

string

Optional, but if you wish to associate the entities within this application with an existing entity group, you can include it here.

string

Optional, but if you wish to create a new entity group with this name, you can include it here.

string
enum

Optional, but if you wish to create a new entity group with this type, you can include it here.

Allowed:
Headers
boolean

This endpoint returns a synchronous response by default. If you would like to override this behavior and get an asynchronous response back immediately, send the header alloy-journey-override-sync as true.

number

Specifies the journey version to create an application from. This includes drafts and inactive versions. If not supplied, the active journey version will be used.

boolean

To run the application using Alloy's sandbox environment, set this header to true.

string

A comma separated list of services that should be run using Alloy's sandbox environment.

boolean

To refresh any cached responses from external services, set this header to true.

string

Specifies the Multi-Environment Configuration to be used with this application.

Responses

Updated 15 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago