This guide will walk you through the various events that occur during an Ignition session.
POST
request to /ignition
can include the following request
body:
redirectUri
(optional) - the URL Axle Ignition will redirect the user to upon completion, exit, or error outcomes of the Ignition session, defaults to no redirectwebhookUri
(optional) - the URL Axle will send events to as the user proceeds through the Ignition session, defaults to no webhook eventsuser
(required) - user to attach. Please refer to startIgnition for more details.metadata
(optional) - optional Ignition session metadata, please refer to startIgnition for more detailsiframe
element in your application.If you would like to receive
MessageEvent
messages to your main application Window from Ignition, you must specify an origin
as a URL parameter when initalizing Ignition. The origin should not include any path, just the base domain as a URI.Example: https://ignition.axle.insure/?origin=http://example.com
redirectUri
provided and in the Window MessageEvent
.
status
: String
authCode
: String - authorization code that can be exchange for accessToken for scoped access to connected account and/or policyclient
: String - the client ID associated with the session. This is primarily useful for platforms who have multiple clients. See the Axle for Platforms guide for more information about platforms.result
: String - “link” (account connection was made and policy is available) OR “basic” (account connection was made but policy details are not available) OR “manual” (policy details were entered through manual collection form)step
: String - the step where the Ignition session was exitedmessage
: String - additional information about the Ignition session errorwebhookUri
is provided, a POST
request will be sent to the webhookUri
with the following payload. The individual parameters included within data
are the same as those listed above for the corresponding status, with the addition of user
and metadata
shared via the Ignition request body:
Type | Data |
---|---|
ignition.created | client : String, token : String, user: Object, metadata: Object |
ignition.completed | client : String, token : String, user: Object, metadata: Object, authCode : String, result : String |
ignition.opened | client : String, token : String, user: Object, metadata: Object |
ignition.exited | client : String, token : String, user: Object, metadata: Object, step : String |
ignition.errored | client : String, token : String, user: Object, metadata: Object, message : String |