Skip to main content
WEBHOOK
merchant_status_update
{
  "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",
    "status": "UP",
    "platform": "ios",
    "sdk": "1.0.0"
  },
  "timestamp": 1710864923198
}

Documentation Index

Fetch the complete documentation index at: https://docs.knotapi.com/llms.txt

Use this file to discover all available pages before exploring further.

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 the availability of a merchant changes on the Knot platform (even if temporarily), including when a brand new merchant is made available for the first time. Availability is unique to product types, platforms, and minimum versions of the SDK. As such, the event is emitted 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.

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:

"MERCHANT_STATUS_UPDATE"

​
merchant
object
​
data
object
​
timestamp
integer

Unix timestamp of the webhook event in UTC.

Example:

1710864923198