Recipes
A recipe is a connection named for what you want to do. You pick one on Apps & connections, under “Build a connection”, after pressing “Start building”. The wizard then shows its steps one at a time, and every step is saved as you move, so you can leave and come back. A recipe the app does not show you is not available on your account yet.
Every recipe ends with the same two steps, “Check” and “Apply”. Test, dry-run and apply describes them.
Let my server call Lingara
Your server gets its own sign-in and password, so it can use Lingara for you.
- Makes: a sign-in for your server (OAuth client), and a password for that sign-in (client secret).
- Steps: “Name and abilities”, “Check”, “Apply”.
- Afterwards: your server signs in with that sign-in and its password, and then calls Lingara with the abilities you gave it in “What it may do”.
An optional script for the sign-in step, which keeps the name you typed and marks it as your server’s:
return lingara.client({ name: input.name + ' (server)', scopes: input.scopes })
Tell my server when a lesson plan is ready
Lingara sends your server a message each time one of your lesson plans is ready.
- Makes: a sign-in for your server, a password for that sign-in, and messages to your server (webhook endpoint).
- Steps: “Name and abilities”, “Where to send it”, “Check”, “Apply”.
- Afterwards: your server receives
lesson_plan.readyat thehttps://address you gave. Each message is signed: one of the passwords shown after applying is the one your server uses to check that a message really came from Lingara.
An optional script for the “Where to send it” step, which also asks for the message sent when a lesson plan could not be made:
return lingara.webhook({ client: input.client, url: input.url, events: [...input.events, 'lesson_plan.failed'] })
Show a card inside Lingara
Your app draws a card on your Home or Lesson plans page.
- Makes: a sign-in for your server, and a card inside Lingara (app manifest).
- Steps: “Name and abilities”, “Your card”, “Check”, “Apply”.
- Afterwards: Lingara asks the address you gave in “Where your app draws the card” for the card, and your app answers with it. One of the passwords shown after applying is the one your app uses to check that a request really came from Lingara.
An optional script for the “Your card” step, which shows the card only in the side column of the home page:
return lingara.app({ client: input.client, manifest: lingara.manifest({ ...input.manifest, slots: ['home.side'] }) })