Appearance
Which parts apply to you
Most products both publish and receive SOM messages. Find your product below, then follow the sections it names. Test the producer side first: it's simpler, and it shows you the bus's verdicts straight away. To see where your product fits in a newsroom, read the newsroom workflows.
| Your product… | Produces | Consumes | Read |
|---|---|---|---|
| Plans or owns stories (NCS, planning, rundown) | story.context | skill.warning.raised, telling.* | Producer, Consumer |
| Publishes stories to platforms (playout, CMS, social) | telling.*, link.* | story.context | Producer, Consumer |
| Stores or ingests media (MAM, media store, ingest) | delivery.media_available | story.context | Producer, Consumer |
| Builds graphics, lower thirds, prompter feeds | link.* | story.context | Producer, Consumer |
| Runs AI skills over stories | skill.warning.raised | story.context | All of the above, and Skills and executors |
| Compliance or standards tooling | system.audit | Most families | Producer, Consumer |
The path through the docs
| Step | Page | Status |
|---|---|---|
| 1 | Plan your integration: your systems, system_ids and message types | Available now |
| 2 | Request access and join your workspace | Via RND |
| 3 | Invite your team: colleagues join with a role, no need to ask RND | Available now |
| 4 | Create your apps and get credentials, and choose how they authenticate | Available now |
| 5 | Validate before you send in the Playground | Available now |
| 6 | Send your first message | Available now |
| 7 | Run a whole story | Available now |
| 8 | Handle the bus's answers and retry safely | Available now |
| 9 | Prove your error paths | Available now |
| 10 | Consume messages with the HTTPS pull API | Available now |
| 11 | Raise warnings from a skill and test it by hand | Available now |
| 12 | Test runs: consumer scenarios and the skill harness, graded case by case | Available now |
| 13 | Readiness checklist and a results statement to share with a publisher | Available now |
What you need
- An approved access request, and a workspace you've joined. See Request access.
- One app per system, created in the portal. See Credentials.
- An HTTPS client that can make an OAuth 2.0 client-credentials request. Any language works.
- A JSON Schema 2020-12 validator for your own tests (recommended).
- No AWS account: consumers read over HTTPS. You need one only to sign with an IAM role, or to read a queue with AWS credentials.