Journeys Events
Alloy uses webhooks to notify you every time a significant event occurs during your Journey Application. Configure your listener to receive these status updates and automatically trigger reactions.
Webhooks can be configured on the Settings page.
To reference which webhook events are sent at each stage of the journey, please see Onboarding with Step Up Journey.
Entity-level vs. Application level events
Journeys can emit Entity-level events (an event that occurs on a specific Entity only, not on the Application as a whole), or Application-level events (an event which occurs across all of the Entities in the Application). Webhooks present the identifying fields of the resource the event is referring to, so when that resource is a group (the Application as a whole), the identifiers will be of that group. This means that for Application-level events, the entity_token or external_entity_token fields will not be an actual Entity token, but will be either null or a Group token (if referring to a Reconciliation Workflow event, since Reconciliation Workflows are run on all of the Entities as a group).
Entity-level events
started_evaluation(for all Worklow types other than Reconciliation Workflows)
pending_review
completed_review
data_request_evaluation
pending_documents
pending_step_up
pending_action
completed_action
reached_retry_node
maximum_retries_reached
pending_action_expired
pending_workflow_service
completed_evaluation(for all Workflow types other than Reconciliation Workflows)
reached_mid_journey_reconciliation_node(this indicates when a given Entity has reached the Mid-Journey Reconciliation Workflow, so while it's related to Reconcliation, it's still Entity-level)
completed_mid_journey_reconciliation
completed_branch
queued_branch_change
executed_branch_change
Application-level events
started_application
started_evaluation(for Reconciliation Workflows only)
completed_review_journey_application
started_reconciliation
completed_reconciliation
completed_evaluation(for Reconciliation Workflows only)
completed_application
started_rerun_application
application_archived
application_unarchived
Journey Status Change Events
Started Application
started_application
A new Journey Application has entered Alloy's system.
Response
{
"request_token": ":request_token",
"timestamp": 1654814723211,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "started_application",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654814723058,
"entity_token": null,
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"position": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Started Evaluation
started_evaluation
The evaluation has begun for a workflow within a Journey and is in process.
Response
{
"request_token": ":request_token",
"timestamp": 1654814723339,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "started_evaluation",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654814725250,
"evaluation_token": ":evaluation_token",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "workflow",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null
}
}
},
"_links": {
"evaluation": {
"href": "/v1/evaluations/:evaluation_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Review
pending_review
An evaluation is in the manual review state and needs to be reviewed to an outcome.
Response
{
"request_token": ":request_token",
"timestamp": 1654815370589,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_review",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654815370504,
"case_token": ":case_token",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "review"
}
},
"_links": {
"case": {
"href": "/v1/cases/:case_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Completed Review
completed_review
An agent has completed a manual review of a Journey Application. This may immediately cause the Journey Application to complete, or may kick off another evaluation (or otherwise continue the Journey Application).
Response
{
"request_token": ":request_token",
"timestamp": 1655233265385,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_review",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"reason": "Other",
"reasons": [
"Other"
],
"note": "Reviewed and approved",
"timestamp": 1655233265276,
"outcome": "Approved",
"case_token": ":case_token",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "review"
}
},
"_links": {
"case": {
"href": "/v1/cases/:case_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Data Request Evaluation
data_request_evaluation
More information about an applicant/entity is needed for our system to advance.
Response
{
"request_token": ":request_token",
"timestamp": 1654814725347,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "data_request_evaluation",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654814725250,
"evaluation_token": ":evaluation_token",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "workflow",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null
}
}
},
"_links": {
"evaluation": {
"href": "/v1/evaluations/:evaluation_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Documents
pending_documents
The Journey Application is waiting for additional documents to be uploaded. Legacy event — should be using pending_step_up (configured by the node type in the Journey editor).
Response
{
"request_token": ":request_token",
"timestamp": 1655418031506,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_documents",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1657582145800,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "docv",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
},
"callback": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token/nodes/:node_id"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Action
pending_action
For an external service or user action, the Journey Application is either waiting for an external service response or an outcome of a user action.
Response
{
"request_token": ":request_token",
"timestamp": 1657582145905,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_action",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1657582145800,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "action",
"config": {
"journey_action_id": 123,
"action_name": ":action_name",
"action_type": null,
"action_version": 0
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
},
"callback": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token/nodes/:node_id"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Action Expired
pending_action_expired
An action node which has an expiration set has reached that time limit.
Response
{
"request_token": ":request_token",
"timestamp": 1659536732193,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_action_expired",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1659536732098,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "action",
"config": {
"journey_action_id": 123,
"action_name": ":action_name",
"action_type": "end_user",
"action_version": 0
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Completed Action
completed_action
For an external service or user action, the Journey Application has received a response from an external service or an outcome of a user action.
Response
{
"request_token": ":request_token",
"timestamp": 1657582145905,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_action",
"journey_type": "application",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1657582145800,
"outcome": "completed",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"type": "action",
"config": {
"journey_action_id": 123,
"action_name": ":action_name",
"action_type": "end_user",
"action_version": 0
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
},
"callback": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token/nodes/:node_id"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Step Up
pending_step_up
A step up has been hit, or any node that requires SDK configuration. Alloy is awaiting documents to continue.
Response
{
"request_token": ":request_token",
"timestamp": 1669776032692,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_step_up",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1669776032582,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"type": "step_up",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null,
"workflow_current_version": null
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
},
"callback": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token/nodes/:node_id"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Step Up Expired
pending_step_up_expired
A step up node which has an expiration set (configured on the Journey editor on the node itself) has reached the specified time limit.
Response
{
"request_token": ":request_token",
"timestamp": 1669776032692,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_step_up_expired",
"journey_type": "application",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1669776032582,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"type": "step_up",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null,
"workflow_current_version": null,
"exp_seconds": 600
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Pending Workflow Service
pending_workflow_service
A node containing an “async” service has been hit, and Alloy is still awaiting the webhook from that service.
Response
{
"request_token": ":request_token",
"timestamp": 1654814725347,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "pending_workflow_service",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654814725250,
"evaluation_token": ":evaluation_token",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "workflow",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null
}
}
},
"_links": {
"evaluation": {
"href": "/v1/evaluations/:evaluation_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Completed Evaluation
completed_evaluation
The evaluation has been concluded.
Response
{
"request_token": ":request_token",
"timestamp": 1654814724388,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_evaluation",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654814725250,
"outcome": "Approved",
"evaluation_token": ":evaluation_token",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "workflow",
"config": {
"application_token": ":application_token",
"workflow_token": ":workflow_token",
"application_version_id": 1,
"workflow_version_id": 1,
"workflow_type": null
}
}
},
"_links": {
"evaluation": {
"href": "/v1/evaluations/:evaluation_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Reached Mid-Journey Reconciliation
reached_mid_journey_reconciliation_node
A mid-Journey Reconciliation Workflow node has been reached (not every Journey must contain a mid-Journey Reconciliation Workflow).
Response
{
"journey_application_event_token": "116712712",
"journey_application_token": "JA-NlqG55XmEIIkkxLCNMuC",
"type": "reached_mid_journey_reconciliation_node",
"journey_type": "application",
"timestamp": 1719342637625,
"entity_token": "P-hCax2OnT6OpUIh6NmquH",
"entity_application_token": "EA-YKv1W3tPFCQ7VKWxqCvL",
"_embedded": {
"node": {
"id": "7b4929c6-01be-48dd-a10b-913085b61635",
"name": "Mid-Journey Recon",
"type": "reconciliation_workflow",
"config": {
"application_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs",
"workflow_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs",
"application_version_id": 0,
"workflow_version_id": 0,
"workflow_type": "reconciliation",
"workflow_current_version": 11
},
"workflow_name": "Mid-Journey Recon"
}
},
"_links": {}
}
Started Mid-Journey Reconciliation
started_mid_journey_reconciliation
A mid-Journey Reconciliation Workflow Evaluation has been started (not every Journey must contain a mid-Journey Reconciliation Workflow).
Response
{
"journey_application_event_token": "116712752",
"journey_application_token": "JA-NlqG55XmEIIkkxLCNMuC",
"type": "started_mid_journey_reconciliation",
"journey_type": "application",
"timestamp": 1719342638831,
"entity_token": "G-apCevjm5sTtpgcx90qJQ",
"entity_application_token": null,
"_embedded": {
"node": {
"id": "7b4929c6-01be-48dd-a10b-913085b61635",
"name": "Mid-Journey Recon",
"type": "reconciliation_workflow",
"config": {
"application_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs",
"workflow_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs",
"application_version_id": 0,
"workflow_version_id": 0,
"workflow_type": "reconciliation",
"workflow_current_version": 11
},
"workflow_name": "Mid-Journey Recon"
}
},
"_links": {}
}
Completed Mid-Journey Reconciliation
completed_mid_journey_reconciliation
A mid-Journey Reconciliation Workflow Evaluation has been completed (not every Journey must contain a mid-Journey Reconciliation Workflow).
Response
{
"journey_application_event_token": "116712763",
"journey_application_token": "JA-NlqG55XmEIIkkxLCNMuC",
"type": "completed_mid_journey_reconciliation",
"journey_type": "application",
"timestamp": 1719342639078,
"outcome": "Approved",
"evaluation_token": "S-0oV5iuJpCH1NM9lWgiR3",
"entity_token": "G-apCevjm5sTtpgcx90qJQ",
"entity_application_token": null,
"_embedded": {
"node": {
"id": "7b4929c6-01be-48dd-a10b-913085b61635",
"name": "Mid-Journey Recon",
"type": "reconciliation_workflow",
"config": {
"application_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs",
"workflow_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs",
"application_version_id": 11,
"workflow_version_id": 11,
"workflow_type": "reconciliation",
"workflow_current_version": 11
},
"workflow_name": "Mid-Journey Recon"
}
},
"_links": {
"evaluation": {
"href": "/v1/evaluations/S-0oV5iuJpCH1NM9lWgiR3"
}
},
"evaluation_tokens_sorted_by_created_dec": [
"S-0oV5iuJpCH1NM9lWgiR3"
]
}
Completed Branch
completed_branch
A journey application has completed the branch within a Journey.
Response
{
"request_token": ":request_token",
"timestamp": 1654814724465,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_branch",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1654814724387,
"outcome": "Approved",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"position": null,
"type": "outcome",
"config": {
"outcome": "Approved"
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Completed Review Journey Application
completed_review_journey_application
This event occurs any time when the Journey Application as a whole has been reviewed by someone (as opposed to completed_review, which happens when an individual entity gets reviewed).
Response
{
"request_token": ":request_token",
"timestamp": 1661960064000,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_review_journey_application",
"journey_type": "application",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"reason": "Denied",
"reasons": [
"Denied Reason"
],
"timestamp": 1661960062512,
"outcome": "Denied",
"case_token": ":case_token",
"entity_token": ":group_entity_token",
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"position": null,
"type": null
}
},
"_links": {
"case": {
"href": "/v1/cases/:case_token"
},
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Started Reconciliation
started_reconciliation
Reconciliation Logic (including the Reconciliation Step if enabled) has started.
Response
{
"request_token": ":request_token",
"timestamp": 1669776580680,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "started_reconciliation",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1669776580567,
"entity_token": null,
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Completed Reconciliation
completed_reconciliation
All entities have completed their Journey and an outcome has been reached based on the Journey's reconciliation logic. After this, the entire Journey Application will either enter manual review, or a terminal outcome will be set and the completed_application event will occur.
Response
{
"request_token": ":request_token",
"timestamp": 1655233265542,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_reconciliation",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1655233265478,
"outcome": "Approved",
"entity_token": null,
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"position": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Completed Application
completed_application
All applicants have completed their Journeys and the Journey Application is no longer open, regardless of whether an outcome was reached. This event will always fire for every Journey Application; if there’s an outcome on this event, that will be the Application’s terminal outcome/decision.
Response
{
"request_token": ":request_token",
"timestamp": 1655233265588,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "completed_application",
"journey_type": "application",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1655233265510,
"outcome": "Approved",
"entity_token": null,
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"type": null
},
"child_entities": [
{
"entity_token": ":entity_token",
"external_entity_identifier": ":external_entity_id"
},
{
"entity_token": ":entity_token",
"external_entity_identifier": ":external_entity_id"
}
]
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Started Rerun Application
started_rerun_application
A re-run has been created off of this Journey Application.
Response
{
"request_token": ":request_token",
"timestamp": 1683319296631,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "started_rerun_application",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1683319296556,
"entity_token": null,
"entity_application_token": null,
"rerun_journey_application_token": ":rerun_journey_application_token",
"_embedded": {
"node": {
"id": null,
"name": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Error
error
An evaluation was unable to reach an outcome, either because of misconfiguration or because a downstream vendor did not return data Alloy needed to continue.
Response
{
"request_token": ":request_token",
"timestamp": 1655418051774,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "error",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"timestamp": 1654814725250,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"external_application_id": ":external_application_id",
"_embedded": {
"node": {
"id": null,
"name": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Reached Retry Node
reached_retry_node
An applicant has reached a retry node. When this happens, the applicant will be sent back to a node designated by the retry node in the Journey.
Response
{
"request_token": ":request_token",
"timestamp": 1669776032692,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "reached_retry_node",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1669776032582,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"type": "retry",
"config": {
"retry_limit": 5
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
},
"callback": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token/nodes/:node_id"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Maximum Retries Reached
maximum_retries_reached
An applicant has reached the maximum number of retries configured on a retry node. When this happens, the applicant will be sent to a subsequent node connected to theRetries Exceeded outcome.
Response
{
"request_token": ":request_token",
"timestamp": 1726056702803,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "maximum_retries_reached",
"journey_type": "application",
"external_application_id": null,
"external_partner_id": null,
"external_group_id": null,
"timestamp": 1726056702512,
"outcome": "Retries Exceeded",
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"_embedded": {
"node": {
"id": ":node_id",
"name": null,
"type": "retry",
"config": {
"retry_limit": 2
}
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Journey Application Archived
application_archived
A journey application has been archived.
Response
{
"request_token": ":request_token",
"timestamp": 1726056702803,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "application_archived",
"journey_type": "application",
"external_application_id": null,
"external_partner_id": null,
"external_group_id": null,
"timestamp": 1726056702512,
"entity_token": ":entity_token",
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"type": null,
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Journey Application Unarchived
application_unarchived
A journey application has been unarchived.
Response
{
"request_token": ":request_token",
"timestamp": 1726056702803,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "application_unarchived",
"journey_type": "application",
"external_application_id": null,
"external_partner_id": null,
"external_group_id": null,
"timestamp": 1726056702512,
"entity_token": ":entity_token",
"entity_application_token": null,
"_embedded": {
"node": {
"id": null,
"name": null,
"type": null,
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": null
}
}
Queued Branch Change
queued_branch_change
An application has determined that it should change branches and will change when it is able. Note that this event will always have a subsequent executed_branch_change event.
Response
{
"request_token": ":request_token",
"timestamp": 1669776032692,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "queued_branch_change",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1669776032582,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"data": {
"newBranchName": ":branch_name",
"originalBranchName": ":branch_name"
},
"_embedded": {
"node": {
"id": ":",
"name": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Executed Branch Change
executed_branch_change
An application processes the previous queued_branch_change event and will begin processing on the new branch. This event will always have a preceding queued_branch_change event.
Response
{
"request_token": ":request_token",
"timestamp": 1669776032692,
"type": "update:journeyapplications:sandbox",
"description": "Notify on sandbox journey application status change",
"data": {
"journey_application_token": ":journey_application_token",
"type": "executed_branch_change",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"timestamp": 1669776032582,
"entity_token": ":entity_token",
"entity_application_token": ":entity_application_token",
"data": {
"newBranchName": ":branch_name",
"originalBranchName": ":branch_name"
},
"_embedded": {
"node": {
"id": ":",
"name": null,
"type": null
}
},
"_links": {
"journey_application": {
"href": "/v1/journeys/:journey_token/applications/:journey_application_token"
}
},
"journey_token": ":journey_token",
"journey_name": ":journey_name",
"external_entity_id": ":external_entity_id"
}
}
Journey Batch Events
Update:Journeybatches
update:journeybatches
A batch of journey applications has finished processing.
Response
{
"request_token": ":request_token",
"timestamp": 1689732009032,
"type": "update:journeybatches",
"description": "A journey batch application run is completed",
"data": {
"journey_batch_status": ":journey_batch_status",
"journey_batch_token": ":journey_batch_token",
"_links": {
"self": {
"href": "/v1/journeys/:journey_token/batches/:journey_batch_token"
}
}
}
}
assign/un-assign Journey Applications Manually
create:agentjourneyapplications
Get notified when an agent is assigned to or un-assigned from Journey Applications.
Response for assignment
{
"request_token": ":request_token",
"timestamp": 1683319296631,
"type": "create:agentjourneyapplications",
"description": "assign/un-assign Journey Applications Manually",
"data": {
"assigned_to": ":agent_email",
"assigned_at": 1683319296631,
"journey_application_token": ":journey_application_token",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"event_type": "ASSIGNED"
}
}
Response for unassignment
{
"request_token": ":request_token",
"timestamp": 1683319296631,
"type": "create:agentjourneyapplications",
"description": "assign/un-assign Journey Applications Manually",
"data": {
"assigned_to": null,
"assigned_at": 1683319296631,
"journey_application_token": ":journey_application_token",
"external_group_id": ":external_group_id",
"external_application_id": ":external_application_id",
"event_type": "UNASSIGNED"
}
}
Updated 4 months ago