Journey Webhooks

Set up your Journey's Webhook

The Journey's webhook handles the applicant's state management. To configure the webhook:

-   Navigate to Settings > Webhooks and click "+ Webhook"
-   Under trigger action, select "Notify on live journey status application change"
-   Fill in the name, endpoint URL, and authentication settings
-   Test the Webhook by clicking the "Test Webhook" button in the bottom left corner
-   When finished, click "Create" to exit and save your changes

Journeys are meant to be used in an asynchronous context. When calling the journey application API, we cannot guarantee a complete response immediately.

All you need to do is:

  • submit your journey
  • listen for the completed_application webhook

Journey Events

However, you may want or need to know more about what happens between start and finish. Don’t worry, we have webhooks that you can subscribe to for every step the user takes:

  • started_application - a new application has entered our system.
  • visited_node - an applicant has moved to a new node of the journey (including the first step).
  • started_evaluation
  • completed_evaluation
  • data_request_evaluation - more information about an applicant is needed for our system to advance, see the section on Updating an Application.
  • waiting_evaluation - an applicant's evaluation is waiting on a third party, typically a document verification vendor. The applicant's journey will automatically continue once the vendor notifies Alloy of a decision.
  • started_review - this event includes a link to the alloy dashboard where you can complete the review. alternately, the review can be completed directly over the API if preferred.
  • completed_review - an 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_branch - an applicant has completed their journey.
  • completed_reconciliation - all applicants have completed their journeys and an outcome has been reached based on the journey's reconciliation logic.
  • completed_application - all 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_entities - for streaming applications, this event signals that the stream has closed on a group application, and no further entities may be submitted.
  • error - an 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 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"
   }
  }
 }
}

Did this page help you?