Alloy will send a webhook for every significant event that occurs during your Journey Application.

Journey Events

EventsDescription
started_applicationA new Application has entered our system
visited_nodeAn applicant has moved to a new node of the Journey (including the first step)
started_evaluationThe evaluation has begun and is in process
completed_evaluationThe evaluation has been concluded
data_request_evaluationMore information about an applicant is needed for our system to advance
completed_reviewAn agent has completed a manual review of an Application. This may immediately cause the Application to complete, or may kick off another evaluation (or otherwise continue the Application)
completed_branchAn applicant has completed their Journey
completed_reconciliationAll applicants have completed their Journeys and an outcome has been reached based on the Journey's reconciliation logic
completed_applicationAll applicants have completed their Journeys and the Application is no longer open, regardless of whether an outcome was reached. This event will always fire for every Application, if there’s an outcome on this event, that will be the Application’s final outcome/decision
has_finished_sending_additional_entitiesFor streaming applications, this event signals that the stream has closed on a Group Application, and no further entities may be submitted
pending_reviewAn evaluation is in the manual review state and needs to be reviewed to a final outcome
pending_actionFor an external service or user action, the Application is waiting for either an external service response or for an outcome of a user action
pending_documentsThe Application is waiting for additional documents to be uploaded
pending_action_expiredThe pending action has timed out
completed_actionCorresponds to pending action, the put request with the results of that action has been successfully received
completed_review_journey_applicationThis event occurs 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)
errorAn evaluation was unable to reach an outcome, either because of misconfiguration or because a downstream vendor did not return data we needed to continue

Example Payloads:

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_group_id": ":external_group_id",
        "timestamp": 1654814724387,
        "outcome": "Approved",
        "entity_token": ":entity_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"
            }
        }
    }
}

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_group_id": ":external_group_id",
        "timestamp": 1654814723058,
        "entity_token": null,
        "_embedded": {
            "node": {
                "id": null,
                "name": null,
                "position": null,
                "type": null
            }
        },
        "_links": {
            "journey_application": {
                "href": "/v1/journeys/:journey_token/applications/:journey_application_token"
            }
        }
    }
}

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_group_id": ":external_group_id",
    "timestamp": 1654814725250,
    "outcome": "Approved",
    "evaluation_token": ":evaluation_token",
    "entity_token": ":entity_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
        }
      }
    },
    "_links": {
      "evaluation": {
        "href": "/v1/evaluations/:evaluation_token"
      },
      "journey_application": {
        "href": "/v1/journeys/:journey_token/applications/:journey_application_token"
      }
    }
  }
}

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_group_id": ":external_group_id",
    "timestamp": 1654815370504,
    "case_token": ":case_token",
    "entity_token": ":entity_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"
      }
    }
  }
}

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": "completed_evaluation",
        "external_group_id": ":external_group_id",
        "timestamp": 1654814725250,
        "evaluation_token": ":evaluation_token",
        "entity_token": ":entity_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
                }
            }
        },
        "_links": {
            "evaluation": {
                "href": "/v1/evaluations/:evaluation_token"
            },
            "journey_application": {
                "href": "/v1/journeys/:journey_token/applications/:journey_application_token"
            }
        }
    }
}

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_group_id": ":external_group_id",
    "timestamp": 1655233265478,
    "outcome": "Approved",
    "entity_token": null,
    "_embedded": {
      "node": {
        "id": null,
        "name": null,
        "position": null,
        "type": null
      }
    },
    "_links": {
      "journey_application": {
        "href": "/v1/journeys/:journey_token/applications/:journey_application_token"
      }
    }
  }
}

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_group_id": ":external_group_id",
    "reason": "Other",
    "reasons": [
      "Other"
    ],
    "timestamp": 1655233265276,
    "outcome": "Approved",
    "case_token": ":case_token",
    "entity_token": ":entity_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"
      }
    }
  }
}

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_group_id": ":external_group_id",
        "timestamp": 1657582145800,
        "entity_token": ":entity_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"
            }
        }
    }
}

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_group_id": ":external_group_id",
        "reason": "example",
        "reasons": [
            "example"
        ],
        "timestamp": 1661960062512,
        "outcome": "Denied",
        "case_token": ":case_token",
        "entity_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"
            }
        }
    }
}

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_group_id": ":external_group_id",
    "timestamp": 1654814725250,
    "evaluation_token": ":evaluation_token",
    "entity_token": ":entity_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
        }
      }
    },
    "_links": {
      "evaluation": {
        "href": "/v1/evaluations/:evaluation_token"
      },
      "journey_application": {
        "href": "/v1/journeys/:journey_token/applications/:journey_application_token"
      }
    }
  }
}

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_group_id": ":external_group_id",
        "timestamp": 1655233265510,
        "outcome": "Approved",
        "entity_token": null,
        "_embedded": {
            "node": {
                "id": null,
                "name": null,
                "position": null,
                "type": null
            }
        },
        "_links": {
            "journey_application": {
                "href": "/v1/journeys/:journey_token/applications/:journey_application_token"
            }
        }
    }
}

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_group_id": ":external_group_id",
        "timestamp": 1655418051691,
        "entity_token": ":entity_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"
            }
        }
    }
}

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_group_id": ":external_group_id",
    "timestamp": 1659536732098,
    "entity_token": ":entity_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"
      }
    }
  }
}

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_group_id": ":external_group_id",
        "timestamp": 1655418031441,
        "entity_token": ":entity_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
                }
            }
        },
        "_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"
            }
        }
    }
}

Example Webhook:

{
 "request_token": ":request_token",
 "timestamp": 1634228613485,
 "type": "update:journeyapplications:sandbox",
 "description": "Notify on sandbox journey application status change",
 "data": {
  "type": "started_evaluation",
  "timestamp": 1634228613426,
  "evaluation_token": ":evaluation_token",
  "entity_token": null,
  "_embedded": {
   "node": {
    "id": ":node_id",
    "type": "workflow",
    "config": {
     "workflow_token": ":workflow_token",
     "workflow_version_id": 1
    }
   }
  },
  "_links": {
   "evaluation": {
    "href": "/v1/evaluations/:evaluation_token"
   },
   "journey_application": {
    "href": "/v1/journeys/:journey_token/applications/:application_token"
   }
  }
 }
}