Lesson plan

Integrating with the Work API

Connect other systems to Moraph Apps with the Work API: keys and scopes, reading and writing records and tasks, pagination, concurrency, idempotency, errors and limits.

Back to the course

Product: Moraph Apps and the Work API
Level: Advanced
For: Implementation partners
Total time: 1 hr 42 min
Lessons: 6 in 3 modules
Assessments: 1

Course objectives

Create a Work API key with the least scopes and a sensible expiry, and store it safely
Authenticate requests and read a product's record types, stages and allowed moves
List records and tasks with filters and cursor pagination, and sync changes with updated_since
Create and update records and tasks without duplicates or lost updates, using Idempotency-Key and version
Handle every error code, the rate limit and read-only products correctly
Rotate and revoke keys without downtime, and use request IDs when working with Moraph Support

Before the course

The Product administrator role in a Moraph Apps product (to create keys), or a colleague who has it
Comfortable with HTTP, JSON and a command line or HTTP client

Module 1: Getting connected (20 min)

Lesson	Type and time	Learners will be able to	Activity and assessment
Keys, scopes and authentication	Reading 10 min	See the lesson	Reading
Reading records and tasks	Reading 10 min	See the lesson	Reading

Module 2: Changing data (22 min)

Lesson	Type and time	Learners will be able to	Activity and assessment
Writing safely: idempotency and versions	Reading 12 min	See the lesson	Reading
Errors, limits and running in production	Reading 10 min	See the lesson	Reading

Module 3: Practice and check (1 hr)

Lesson	Type and time	Learners will be able to	Activity and assessment
Practical: build a small, safe sync	Practical exercise 45 min	See the lesson	Practical exercise with a checklist
Check your understanding	Assessment 15 min	See the lesson	10 questions · pass mark 80% · 3 attempts

Completing the course

Every lesson must be completed: reading lessons are marked complete by the learner, exercises when every checklist item is confirmed, and assessments only when passed. Completing the course issues a certificate of completion with a verification code.