Knock

Generate a Knock user token for the current user

post

Query parameters

workspace_idstring · uuidOptional

The id of the workspace

drive_idany ofOptional

The id of the drive. If provided, generates a token scoped to workspace + this drive only. If omitted, generates a token for workspace + all drives (legacy, avoid with 50+ drives).

string · uuidOptional

or

nullOptional

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/knock/token

HTTPcURLJavaScriptPython

POST /knock/token HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "token": "text",
  "expires_at": 1
}

Fetch Knock notification preferences for a drive

get

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/knock/drives/{drive_id}/preferences

HTTPcURLJavaScriptPython

GET /knock/drives/{drive_id}/preferences HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Update Knock notification preferences for a drive

put

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

put

/knock/drives/{drive_id}/preferences

HTTPcURLJavaScriptPython

PUT /knock/drives/{drive_id}/preferences HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "preferences": {
    "id": "default",
    "workflows": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}