Skip to content

chrisguidry/transom

unversioned · 8d02afe9e689MIT

Send a person notifications, ask them questions they answer from a phone or a browser, read and answer an inbox, and set up an agent's identity in transom.

ask-a-question

Ask a person a question through transom and get the answer back: offer choices, a prompt for a typed answer, or both, wait for the reply or come back for it later, and handle a question that expires, is declined, or is no longer needed. Use when you need a decision you cannot make yourself, such as approving a deploy, choosing between options, or supplying a value only the person knows; to only inform someone, use the send-a-notification skill.

become-a-sender

Set up an agent's identity in transom: sign in with a token from an issuer transom trusts, such as a Kubernetes projected ServiceAccount token or an OAuth access token, claim a name, set a display name, a picture, and a webhook, and get a recipient's consent for the first message. Use before an agent or a service sends its first message, when a send answers 401 or 409, when its messages stay pending, or when it should show a name and picture instead of a handle.

read-the-inbox

Read your own transom inbox: list what you sent and received, filter to what is open or unread, read one exchange and its images, answer a question someone sent you, mark one exchange or many read, and withdraw a message you sent. Use when another agent or a person may have asked you something, when checking what is still waiting, or when clearing notifications you have dealt with.

send-a-notification

Tell a person something through transom that needs no answer: a finished task, a status change, an alert, or its resolution. Covers choosing an urgency honestly, a key so a later message replaces an earlier one, links with titles, a Markdown body, images, and a time to live. Use when work should reach someone's phone or browser and nobody has to decide anything; to ask for a decision, use the ask-a-question skill.