Expand description
The request and response types HEY speaks, generated from the model.
Structs§
- Account
- Account — a HEY account
- AddPostings
ToBox Group Request Content - Addressed
- Addressed recipients
- Addressed
Sender - AddressedSender — sender context
- Advanced
Search Filters - AdvancedSearchFilters — the options the advanced search refine form offers
- Advanced
Search Result - Attached
Entry - AttachedEntry — entry reference on a calendar event
- Attendance
- Attendance — calendar event attendee
- BadRequest
Error Response Content - BoxGroup
- BoxGroup — a Set Aside group. The API only ever returns the id.
- BoxGroup
With Postings - BoxGroupWithPostings — a Set Aside group with one page of the postings in it
- BoxGroups
Response - BoxGroupsResponse — the wrapper the groups index answers with
- BoxShow
Response - BoxShowResponse — box detail with postings.
The API can return fields at root level or nested under a
boxkey. SDK response decoders normalize the nested variant to flat before decoding. - Bubble
UpSchedule - BubbleUpSchedule
- Bulk
Reply Delivery - Bulk
Reply Draft - The reply as HEY would send it: the prefilled content and the entries it goes to.
- Bulk
Reply Entry - One thread a bulk reply answers, with the recipients that thread’s reply goes to.
- Bulk
Reply Message Payload - Bulk
Reply Request Content - Wire format: {entry_ids: […], message: {content}}
- Bulk
Update Clearances Request Content - Calendar
- Calendar
- Calendar
DayList Payload - Calendar
List Payload - CalendarListPayload
- Calendar
Period - CalendarPeriod — a day or a week: its bounds and everything in it, grouped by type. Recurring events arrive expanded into the occurrences that fall inside the window, which is what makes this a different answer than the recordings a calendar lists.
- Calendar
Selection - CalendarSelection — the calendars a toggle left switched on
- Calendar
Todo Changes - Nothing here is required: a rename sends a title and leaves the day alone.
- Calendar
Todo Payload - Calendar
Week List Payload - Calendar
With Recording Changes Url - CalendarWithRecordingChangesUrl — wraps calendar with sync URL
- Calendar
Year - CalendarYear — the grid a year is drawn as. A year carries one entry per day plus the events that span more than one, not every recording it holds: a year’s worth of expanded occurrences is not something a client asks for by opening a year.
- Calendar
Year Day - Clearance
- Clearance — screening status for a contact
- Clearance
List Response - ClearanceListResponse — wire format: {clearances: […]}
- Clearance
Summary - ClearanceSummary — the Screener’s pending count, and the queue itself when asked for
- Clip
- Clip
Topic - The topic a clip was taken from
- Collection
- Collection — email collection/label
- Collection
Payload - Collection
With Postings - CollectionWithPostings — collection detail with its threads as posting objects
- Conflict
Error Response Content - The request conflicts with current state, e.g. starting a time track while one is already ongoing. Time tracks answer {“error”: “…”}; contact writes answer the {“errors”: […]} list every other error path uses.
- Contact
- Contact — the identity of someone in HEY
- Contact
Detail - ContactDetail — extended contact with additional show fields
- Contact
Note - A contact’s private note. Empty strings when there is no note.
- Contact
Note Payload - Contact
Note Request Content - Wire format: {contact: {note: “…”}}
- Contact
Payload - Contact
Request Content - Wire format: {contact: {name, email_address, alias_email_addresses: […]}}
- Create
BoxDesignation Request Content - Create
BoxGroup Request Content - Create
Calendar Todo Request Content - Wire format: {calendar_todo: {title, starts_at}}
- Create
Contact Request Content - Wire format: {acting_user_id, contact: {…}} — creating also has to say which account the contact belongs to, since one identity can hold several.
- Create
Direct Upload Request Content - Create
Folder ForPostings Request Content - Wire format: {posting_ids: […], folder: {name, status}}
- Create
Message Request Content - Wire format: {acting_sender_id, message: {subject, content}, entry: {addressed: {directly: “…”}}}
- Create
Reply Request Content - Wire format: {acting_sender_id, message: {subject, content}, entry: {addressed: {directly: […]}}} entry.addressed is optional on the wire but a reply posted without it is saved as a draft rather than delivered — HEY does not reply-all for the caller. Resolve the thread’s recipients first and always send them.
- Deleted
Posting - DeletedPosting — the stub the changes feed answers with for a posting that is gone
- Direct
Upload - Direct
Upload Blob - Direct
Upload Target - Domain
- Domain — email domain
- Draft
Message - DraftMessage — a draft entry
- Entry
- Entry — a message entry within a topic
- Extenzion
- Extenzion — external account extension
- External
Account - File
Postings Request Content - First
Week DayParams - First
Week DayPreference - Folder
- Folder — email folder
- Folder
Payload - Folder
With Postings - FolderWithPostings — folder detail with the postings filed in it
- Forbidden
Error Response Content - GetBox
Posting Changes Response Content - GetBundle
Unseen Postings Response Content - Habit
Payload - Habit
Request Content - Wire format: {calendar_habit: {name, icon, color, days: [0..6]}}
- Identity
- Internal
Server Error Response Content - Join
Link - JoinLink — video/meeting join link
- Journal
Entry Payload - Mailbox
- Box — a HEY mailbox
- Mark
Postings Request Content - Message
- Message — full message detail
- Message
Addressed - Recipients per kind, each a list of email addresses. haystack applies Array() to each kind, so a JSON array is the correct wire format (a bare string would be treated as a single address, not split on commas).
- Message
Draft - MessageDraft — a prefilled compose payload (forward, reply). Unsent, so it has no id.
- Message
Edit State - MessageEditState — a saved draft as the editor sees it. The same compose fields as MessageDraft, plus the identity and scheduling a saved entry carries.
- Message
Entry Payload - Message
Payload - Message
Posting Context - MessagePostingContext — posting context for a message
- Move
Postings Request Content - Move
Sticky Request Content - Wire format: {id, position} — both at the top level.
- Move
Topic Request Content - Move
Workflow Staging Request Content - Navigation
Icon - NavigationIcon
- Navigation
Item - NavigationItem
- Navigation
Response - NavigationResponse
- NotFound
Error Response Content - Organizer
- Organizer — calendar event organizer
- Posting
- Posting — polymorphic by
kind(topic, bundle, entry) - Posting
Note - Note — a posting note
- Recording
- Recording — polymorphic by
type(Calendar::Event, Calendar::Todo, etc.) - Recurrence
Schedule - RecurrenceSchedule
- Reminder
- Reminder
- Reply
Message Payload - HEY does not derive a subject for a reply: a reply draft saved without message.subject reads “No subject” in Drafts. NewEntryReply hands back the prefilled subject (“Re: …”) — send it here. Content is the caller’s reply body alone: the server appends the quoted original at delivery (auto_quoting defaults on), so the prefill’s quoted content must not be echoed back.
- Schedule
Postings Bubble UpRequest Content - Search
Filter Item - SearchFilterItem — one option offered by the advanced search refine form
- Search
Match - One matching topic: the topic, your posting of it (if any), and the entries that matched.
- Sender
- Sender — a contact with default flag
- Service
Unavailable Error Response Content - Snippet
- Sticky
- Sticky — a note on the stickies board
- Sticky
Payload - Sticky
Request Content - Wire format: {sticky: {body, size}}. Size is “small”, “medium” or “large”.
- Time
Format Preference - Time
Track Category - Time
Track Request Content - Topic
- Topic detail
- Topic
List Response - TopicListResponse — wrapped topic list (sent, spam, trash, everything)
- Topic
Publication - Tracked
Time - The tracked-time index: a page of completed tracks, and every category they can be filed under.
- Trash
Postings Request Content - Unauthorized
Error Response Content - Unprocessable
Entity Error Response Content - The server rejected what was sent. HEY answers {“errors”: [“…”]} — the messages the model itself produced — so a client can show them as they are.
- Update
Calendar Todo Request Content - Wire format: {calendar_todo: {title, starts_at, focused}}
- Update
Clearance Request Content - Wire format: {status: “approved”|“denied”} — top level, not nested under a clearance key.
- Update
Collection Request Content - Wire format: {collection: {name, summary}}
- Update
Contact Clearance Request Content - Wire format: {status: “approved”|“denied”} — top level, not nested under a clearance key.
- Update
First Week DayRequest Content - Wire format: {identity_preference: {first_week_day: “monday”}}
- Update
Journal Entry Request Content - Wire format: {calendar_journal_entry: {content}}
- Update
MyClearance Request Content - Update
Time Format Request Content - Update
Time Track Payload - Update
Time Track Request Content - Wire format: {calendar_time_track: {notes, category_title, starts_at, ends_at}}
- Updates
Channel - UpdatesChannel — streaming channel for a box
- User
- User — a user within an account
- Workflow
- Workflow — email workflow/label
- Workflow
Stage - Workflow
Staging Payload
Type Aliases§
- Advanced
Search Response Content - Bulk
Update Clearances Response Content - Calendar
Recordings Response - CalendarRecordingsResponse — recordings grouped by type
- Complete
Calendar Todo Response Content - Complete
Habit Response Content - Create
BoxGroup Response Content - Create
Bulk Reply Response Content - Create
Calendar Todo Response Content - Create
Contact Response Content - Create
Habit Response Content - Create
Sticky Response Content - Create
Time Track Response Content - Direct
Upload Headers - GetAdvanced
Search Filters Response Content - GetAsidebox
Response Content - GetBox
Group Response Content - GetBox
Response Content - GetBubblebox
Response Content - GetCalendar
DayResponse Content - GetCalendar
Recordings Response Content - GetCalendar
Week Response Content - GetCalendar
Year Response Content - GetClearances
Response Content - GetCollection
Response Content - GetContact
Note Response Content - GetContact
Response Content - GetEverything
Topics Response Content - GetFeedbox
Response Content - GetFolder
Response Content - GetIdentity
Response Content - GetImbox
Response Content - GetImbox
Seen Response Content - GetJournal
Entry Response Content - GetLaterbox
Response Content - GetMessage
Edit Response Content - GetMessage
Response Content - GetMy
Clearances Response Content - GetNavigation
Response Content - GetOngoing
Time Track Response Content - GetSent
Topics Response Content - GetSpam
Topics Response Content - GetTopic
Entries Response Content - GetTopic
Publication Response Content - GetTopic
Response Content - GetTrailbox
Response Content - GetTrash
Topics Response Content - GetWorkflow
Response Content - GetWorkflow
Stage Output Payload - List
BoxGroups Response Content - List
Boxes Response Content - List
Calendar Days Response Content - List
Calendar Weeks Response Content - List
Calendars Response Content - List
Clips Response Content - List
Collections Response Content - List
Contacts Response Content - List
Drafts Response Content - List
Journal Entries Response Content - List
Snippets Response Content - List
Stickies Response Content - List
Time Track Categories Response Content - List
Time Tracks Response Content - NewBulk
Reply Response Content - NewEntry
Forward Response Content - NewEntry
Reply Response Content - Reveal
Contact Response Content - Start
Time Track Response Content - Toggle
Calendar Response Content - Uncomplete
Calendar Todo Response Content - Uncomplete
Habit Response Content - Update
Calendar Todo Response Content - Update
Clearance Response Content - Update
Contact Note Response Content - Update
Contact Response Content - Update
First Week DayResponse Content - Update
Habit Response Content - Update
Journal Entry Response Content - Update
MyClearance Response Content - Update
Sticky Response Content - Update
Time Format Response Content - Update
Time Track Response Content