Connecting to a BDK Book

Learn how to connect to Books built with BDK in Kognitos.

Before connecting to your custom Book, you must first learn it.

Syntax

Use the following syntax to connect to your custom Book in a Kognitos automation.

Basic Syntax

connect {book name}

Specifying a Noun Phrase

If a noun phrase is implemented in your Book's @connect decorator, include via {preposition} {noun phrase}. Choose a preposition that matches the plurality of the noun phrase. For example:

• For a plural noun phrase: via some API keys

• For a singular noun phrase: via a client credentials method

connect {book name} via {preposition} {noun phrase}

Passing Arguments

Arguments can be passed to your connection using the with keyword:

connect {book name} via {preposition} {noun phrase} with
  the {argument 1} is "{value 1}"
  the {argument 2} is "{value 2}"
  the {argument 3} is "{value 3}"

---

Examples

1. Basic Connection

connect yaml

2. Passing Connection Arguments

connect education with
  the username is "admin"

3. Using a Noun Phrase

connect grimoire via the magic method

4. Using a Noun Phrase and Connection Arguments

In this example, api keys is the noun phrase, and several connection arguments are provided.

connect photon via some api keys with
  the api key is "1234-5678-ABCD-EFGH"
  the client id is "client-98765"
  the secret key is "s3cr3tK3y!"
  the username is "photon_user"
  the password is "P@ssw0rd!"