How to get event.info.deviceDescription in events webhook (ex user.login.success)?

[rabah.laouadi]

Hello everyone,

We’re trying to retrieve the event.info.deviceDescription field from the user.login.success webhook event, but it doesn’t seem to appear in the payload.

Here’s an example of what we receive:

"event": {
  "applicationId": "af28e0b2-124b-4c98-b8b5-30322e98de79",
  "authenticationType": "PASSWORD",
  "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
  "createInstant": 1759824184881,
  "id": "c3e5c82a-91cc-451c-9bcc-104803d29f87",
  "info": {
    "deviceName": "macOS Chrome",
    "deviceType": "BROWSER",
    "ipAddress": "192.168.65.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"
  },
  "ipAddress": "192.168.65.1",
  "linkedObjectId": "69384417-206b-4c21-a4e7-22f8c93ed516",
  "tenantId": "68530993-d5d0-43c5-9278-115524701723",
  "type": "user.login.success",
  "user": {
          "active": true,
          "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",

          "data": {
            ...
          },
          "email": "XXXX",
          "id": "69384417-206b-4c21-a4e7-22f8c93ed516",
          "identities": [
            {
              "insertInstant": 1759295385386,
              "lastLoginInstant": 1759761531077,
              "lastUpdateInstant": 1759295385386,
              "primary": true,
              "type": "email",
              "value": "XXXXX",
              "verified": false,
              "verifiedReason": "Trusted"
            },
            {
              "insertInstant": 1759295385386,
              "lastLoginInstant": 1759824184881,
              "lastUpdateInstant": 1759295385386,
              "primary": true,
              "type": "phoneNumber",
              "value": "XXXXXX",
              "verified": false,
              "verifiedReason": "Trusted"
            }
          ],
          "insertInstant": 1759295385386,
          "lastLoginInstant": 1759824184881,
          "lastUpdateInstant": 1759295385386,
          "memberships": [],
          "passwordChangeRequired": false,
          "passwordLastUpdateInstant": 1759295385391,
          "phoneNumber": "XXXXXX",
          "preferredLanguages": [],
          "registrations": [
            {
              "applicationId": "af28e0b2-124b-4c98-b8b5-30322e98de79",
              "data": {},
              "id": "d57496f5-98de-4e36-9aa0-01b7b56fca50",
              "insertInstant": 1759295385398,
              "lastLoginInstant": 1759824184881,
              "lastUpdateInstant": 1759295385398,
              "preferredLanguages": [],
              "roles": [],
              "tokens": {},
              "usernameStatus": "ACTIVE",
              "verified": true,
              "verifiedInstant": 1759295385398
            }
          ],
          "tenantId": "68530993-d5d0-43c5-9278-115524701723",
          "twoFactor": {
            "methods": [
              {
                "id": "SGN8",
                "lastUsed": true,
                "method": "sms",
                "mobilePhone": "XXXXXX"
              }
            ],
            "recoveryCodes": []
          },
          "usernameStatus": "ACTIVE",
          "verified": true,
          "verifiedInstant": 1759295385386
        }
      }

I tried setting metaData.device.description in the authorize request, like so:

GET /oauth2/authorize?...&metaData.device.description=MyDescription

But the description still doesn’t appear in the event payload.

Am I missing a configuration step, or is deviceDescription not included in this webhook by default?

Thanks in advance for any help!

[mark.robustelli]

@rabah-laouadi What information is in the device.description that is not in the info section?

"info": {
    "deviceName": "macOS Chrome",
    "deviceType": "BROWSER",
    "ipAddress": "192.168.65.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"
  },

Or are you specifically trying to get a custom value in your url? If you let us know a little more about what exactly you want to accomplish, we may be able to find a way to get it done.

Also have you seen this post?

[rabah.laouadi]

@mark-robustelli Thanks for the anwser

The solution is to add [@hidden name="metaData.device.description"/] the below line to it within Advanced Theme within the Helpers file under

[#macro oauthHiddenFields]
    // here 
    [@hidden name="metaData.device.description"/]
    ...
    [@hidden name="captcha_token"/]
    [@hidden name="client_id"/]
    [@hidden name="code_challenge"/]
    [@hidden name="code_challenge_method"/]
    [@hidden name="metaData.device.name"/]
    [@hidden name="metaData.device.type"/]
    [@hidden name="nonce"/]
    [@hidden name="oauth_context"/]
    [@hidden name="pendingIdPLinkId"/]
    [@hidden name="prompt"/]
    [@hidden name="redirect_uri"/]
    [@hidden name="response_mode"/]
    [@hidden name="response_type"/]
    [@hidden name="scope"/]
    [@hidden name="state"/]
    [@hidden name="tenantId"/]
    [@hidden name="timezone"/]
    [@hidden name="user_code"/]
[/#macro]