Journeys Example Payloads
Below are examples of payloads for each webhook event type
started_application
{
"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",
"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
{
"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",
"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
{
"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",
"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
{
"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",
"reason": "Other",
"reasons": [
"Other"
],
"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
{
"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",
"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
{
"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",
"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
{
"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",
"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
{
"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",
"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"
}
}
pending_step_up
{
"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",
"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_workflow_service
{
"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",
"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
{
"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",
"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"
}
}
completed_branch
{
"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",
"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
{
"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",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"reason": "example",
"reasons": [
"example"
],
"timestamp": 1661960062512,
"outcome": "Denied",
"case_token": ":case_token",
"entity_token": null,
"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
{
"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",
"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
{
"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",
"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
{
"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",
"external_partner_id": ":external_partner_id",
"external_group_id": ":external_group_id",
"timestamp": 1655233265510,
"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
}
}
started_rerun_application
{
"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",
"timestamp": 1683319296556,
"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
}
}
error
{
"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",
"_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"
}
}
Updated 21 days ago