Dropoff events payload

You can use the following dropoff event payloads to trigger asynchronous workflows and synchronizations for event notification webhooks and APIs.

Table 1. Dropoff attributes
Name Data type Description
data.devicetype String What type of device the registration came from.
data.flow_document_id String The UUID of the registration document where the user registered.
data.flow_id String The UUID of the flow that the user registered from.user registration flow ID
data.flow_name String The user registration flow name. flow that the user registered from.
data.flow_url String The URL of the flow that the user registered from.
data.origin String IP address that the user registered from.
data.realm String

Identity source of user. Examples

Cloud Directory - CloudIdentityRealm,

IBMid - www.ibm.com

SAML Enterprise - AzureRealm

LDAP pass-through - www.cloudsecurity.com

OIDC - www.yahoo.com

data.result String The dropoff result of the user registration attempt, either successful or abandoned.
data.session_id String Session ID in the profile service that was used to register the user.
data.step String The last step that the user was on during the registration when this event was triggered.
data.subtype String The subtype is registration for a drop off event type.
data.timetaken String Time taken for successful or abandoned registration.
data.userid String The user's ID.
data.username String The uusername of the user that is being registered.
geoip.city_name

geoio.continent_name

geoip.country_iso_code

geoip.country_name

geoip.location

geoip.region_name

String Augmented by Event service by using data.origin.

Example

The following code is a sample payload. Use the Events APIs to get the actual attributes. See https://docs.verify.ibm.com/verify/reference/getallevents and https://docs.verify.ibm.com/verify/docs/pulling-event-data.

{
   "_index":"event-dropoff-2023.9-000001",
   "_type":"_doc",
   "_id":"1aa1aa11-11a1-1a1a-11a1-a1a1aaa11aa1",
   "_version":1,
   "_score":1,
   "_source":{
      "geoip":{
         "continent_name":"North America",
         "as_org":"AMAZON-02",
         "city_name":"Columbus",
         "country_iso_code":"USA",
         "ip": "222.22.22.222",
         "country_name":"United States",
         "region_name":"Ohio",
         "location":{
            "lon":"-82.9987",
            "lat":"39.9587"
         },
         "asn":16509
      },
      "data":{
         "flow_url": "333333333333333333333333333",
         "origin":"222.22.22.222",
         "endtime":1694444562985,
         "flow_name":"My test flow name",
         ""session_id":"b-333b-3b33-b3b3-b333333b3bbb",
         "starttime":1694443582505,
         "laststep_step":"1",
         "userid":"444444G444",
         "devicetype":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Firefox/102.0",
         "flow_document_id":"cc555c55-5cc5-5c5c-5555-cc5cccc4255cc5",
         "result":"abandoned",
         "laststep":"completed",
         "timetaken":940240,
         "subtype":"registration",
         "flow_id":"666ddddd-6666-666d-6666-d66d66666d66",
         "laststep_status":"failure",
         "realm":"cloudIdentityRealm",
         "username":"username.cloudidentity.ibm.com"
      },
      "year":2023,
      "event_type":"dropoff",
      "month":9,
      "indexed_at":1694445016610,
      "tenantid":"e48346e2-159b-4aed-8ccd-30546e2c2be5",
      "tenantname":"tenant name.ibmcloudsecurity.com",
      "correlationid":"CORR_ID-7ee7ee77-77e7-7e7e-77e7-e7e7eee77ee7",
      "servicename":"analytics-sparkservice",
      "id":"7ee7ee77-77e7-7e7e-77e7-e7e7eee77ee7",
      "time":1694445016102,
      "day":11
   }
}