​
AUTHENTICATED

Fired when the authentication to a merchant is successful.

{
  "event": "AUTHENTICATED",
  "session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
  "task_id": 25605,
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "merchant": {
    "id": 10,
    "name": "Uber"
  },
  "data": {
    "card_id": "123456789",
    "send_card": true,
    "entrypoint": "onboarding"
  },
  "timestamp": 1710864923198
}

​
SYNC_CART_SUCCEEDED

Triggered when adding products to a user’s merchant cart is successful. See the full event payload here.

​
SYNC_CART_FAILED

Triggered when adding products to a user’s merchant cart fails. See a sample payload below:

{
  "event": "SYNC_CART_FAILED",
  "external_user_id": "{your-unique-identifier}",
  "merchant": {
    "id": 7,
    "name": "Best Buy",
    "logo": "https:\/\/knot.imgix.net\/merchants\/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png?auto=format&w=240"
  },
  "timestamp": 1710864923198
}

​
CHECKOUT_SUCCEEDED

Triggered when checkout succeeds for a user’s merchant cart. See a sample payload below:

{
  "event": "CHECKOUT_SUCCEEDED",
  "external_user_id": "{your-unique-identifier}",
  "merchant": {
    "id": 7,
    "name": "Best Buy",
    "logo": "https:\/\/knot.imgix.net\/merchants\/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png?auto=format&w=240"
  },
  "data": {
    "transactions": [
      {
	    "id": "13da3c28-a068-4642-9ce2-b730cfda5f5f"
	  },
	  {
	    "id": "8f2a1c71-4b03-4458-a3f7-c5e6a4dc1d2b"
	  }
    ]
  },
  "timestamp": 1710864923198
}

​
CHECKOUT_FAILED

Triggered when checkout fails for a user’s merchant cart. See a sample payload below:

{
  "event": "CHECKOUT_FAILED",
  "external_user_id": "{your-unique-identifier}",
  "merchant": {
    "id": 7,
    "name": "Best Buy",
    "logo": "https:\/\/knot.imgix.net\/merchants\/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png?auto=format&w=240"
  },
  "timestamp": 1710864923198
}

​
ACCOUNT_LOGIN_REQUIRED

Triggered when a user’s merchant account is disconnected and requires the user to login again to reconnect the account. See a sample payload below:

{
  "event": "ACCOUNT_LOGIN_REQUIRED",
  "external_user_id": "{your-unique-identifier}",
  "merchant": {
    "id": 36,
    "name": "Uber Eats",
    "logo": "https:\/\/knot.imgix.net\/merchants\/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png?auto=format&w=240"
  },
  "timestamp": 1710864923198
}

​
MERCHANT_STATUS_UPDATE

Listening to this event is only necessary if you intend to display and allow users to select various merchants natively inside your app.

Fired when a merchant becomes available or unavailable (even if temporarily), including when a brand new merchant is made available on the Knot platform for the first time.

Availability is unique to product types, platforms, and versions of the SDK. As such, the event will fire independently for each product type and platform. Particularly if you are implementing multiple of Knot’s products, you should consider the type property to determine whether a merchant is available for a given product, as availability can differ.

This event does not include a session_id, which is relevant when generating a hash map for webhook verification, as described in Webhook Verification.

{
  "event": "MERCHANT_STATUS_UPDATE",
  "merchant": {
    "id": 10,
    "name": "Uber",
	"category": "Transportation",
    "logo": "https:\/\/knot.imgix.net\/merchants\/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png?auto=format&w=240"
  },
  "data": {
    "type": "card_switcher", // card_switcher, transaction_link
	"status": "UP", // UP, DOWN
    "platform": "ios", // ios, android, web
    "sdk": "1.0.0" // nullable
  },
  "timestamp": 1710864923198
}