Lingara getting started

Connect your own server or app to your Lingara account without writing an integration from scratch. You pick a recipe, fill in a few fields, check the result against Lingara’s real rules, and then apply it. Scripts are optional.

What you can build

A connection is made of four building blocks. Each is named here in the app’s words, with the term Lingara uses for it beside it:

• A sign-in for your server (OAuth client). Your server uses it to act on your account.
• A password for that sign-in (client secret). You see it once, right after applying.
• Messages to your server (webhook endpoint). Lingara sends your server a message when something happens, such as a lesson plan being ready.
• A card inside Lingara (app manifest). Your app draws a card on your Home or Lesson plans page.

You never have to put these together by hand. A recipe chooses the blocks and the order, and “Check it” tells you what will be made before anything is.

Tell my server when a lesson plan is ready

This recipe makes a sign-in, its password, and the messages. Start in the web app, and follow the wizard’s own words:

1. On Apps & connections, under “Build a connection”, press “Start building” and pick “Tell my server when a lesson plan is ready”.
2. In “Name and abilities”, name the sign-in.
3. In “Where to send it”, give your server’s https:// address. You can also open “Use a script”, paste the script below, and press “Try it”.
4. In “Check”, press “Check it” and read “Here’s what will be created”.
5. Press “Apply”, and copy each password as it appears. Each is shown once.
6. Generate a lesson plan and watch your server receive lesson_plan.ready.

The script is optional. This one does what the fields do, and adds the message Lingara sends when a lesson plan could not be made:

return lingara.webhook({ client: input.client, url: input.url, events: ['lesson_plan.ready', 'lesson_plan.failed'] })

What next

• Recipes describes all three recipes and what to do with what each one makes.
• Test, dry-run and apply explains what “Check it” checks and what “Apply” does.
• Lingara developer documentation lists everything a script can call.
• Everything a connection makes, you can also make by hand in Developer tools, in the web app.