Skip to main content
WEBHOOK
new_detected_accounts_available
{
  "event": "NEW_DETECTED_ACCOUNTS_AVAILABLE",
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "data": {
    "detected_accounts": [
      {
        "id": 35,
        "name": "Spotify",
        "logo": "https://knot.imgix.net/merchants/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png"
      },
      {
        "id": 44,
        "name": "Walmart",
        "logo": "https://knot.imgix.net/merchants/walmart.png"
      },
      {
        "id": 84,
        "name": "Chewy",
        "logo": "https://knot.imgix.net/merchants/chewy.png"
      },
      {
        "id": 71,
        "name": "Verizon",
        "logo": "https://knot.imgix.net/merchants/verizon.png"
      },
      {
        "id": 53,
        "name": "Airbnb",
        "logo": "https://knot.imgix.net/merchants/airbnb.png"
      }
    ]
  },
  "timestamp": 1710864923198
}

​
Usage

Detected accounts sent in this webhook event can be used to closely personalize the merchants you present to users in your app or through lifecycle marketing campaigns. For example, if a detected account at Uber is present for a user, you can more prominently display Uber to that user in your app or as a push notification/email. Moreover, aggregated detected account information can be useful in designing a rewards program or other product features throughout your app.

​
Testing

To test receiving the NEW_DETECTED_ACCOUNTS_AVAILABLE webhook in the development environment, either call the Detect Accounts endpoint or pass the user’s email into the email field when calling Create Session. Note that the Detect product must be enabled for your account to receive the webhook event. Please reach out to the Knot team to enable Detect.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Body

application/json
​
event
string

Name of the webhook event.

Example:

"NEW_DETECTED_ACCOUNTS_AVAILABLE"

​
external_user_id
string

Unique identifier for the user.

Example:

"3dcbb19a-b2f1-4a7b-8792-d76027b627b3"

​
data
object
Example:
{
  "detected_accounts": [
    {
      "id": 35,
      "name": "Spotify",
      "logo": "https://knot.imgix.net/merchants/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png"
    },
    {
      "id": 44,
      "name": "Walmart",
      "logo": "https://knot.imgix.net/merchants/walmart.png"
    },
    {
      "id": 84,
      "name": "Chewy",
      "logo": "https://knot.imgix.net/merchants/chewy.png"
    },
    {
      "id": 71,
      "name": "Verizon",
      "logo": "https://knot.imgix.net/merchants/verizon.png"
    },
    {
      "id": 53,
      "name": "Airbnb",
      "logo": "https://knot.imgix.net/merchants/airbnb.png"
    }
  ]
}
​
timestamp
integer

Unix timestamp of the webhook event in UTC.

Example:

1710864923198