Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Optionally, configure receiving Events for AgentMail into StackOne.
Connector Profile · API Key
No app registration required. Organization keys reach every inbox, while pod- or inbox-scoped keys only reach resources…
Webhooks setup
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · API Key
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
63 actions
Action
Description
Get Calendar
Gets the inbox’s calendar.
Update Calendar
Updates the calendar’s default time zone.
List Events
Lists the events stored on the calendar: one item per one-off or recurring event, plus one item for each edited date of…
Create Event
Creates a one-off or recurring event on the inbox’s calendar.
Get Agenda
Lists every date on the calendar in a time window, ordered by start time: one-off events, and recurring events expanded…
Get Event
Gets an event by its UUID, or one date of a recurring event by its dated ID (<uuid>_<slot>).
Update Event
Update a calendar event on an inbox’s calendar, optionally guarded by its ETag.
Delete Event
Deletes an event, or cancels dates of a recurring event.
List Event Instances
Lists the dates of one recurring event in a time window, in start order, with each date’s edits applied.
Respond To Event
Accepts, declines or tentatively accepts an invitation the inbox received by email.
List Domains
List the custom sending domains registered in the AgentMail organization.
Create Domain
Register a custom domain so inboxes can send and receive on it.
Get Domain
Get a custom domain with its DNS records and verification status.
Update Domain
Update the settings of a registered custom domain.
Delete Domain
Delete a custom domain from the organization.
Get Zone File
Get the DNS zone file of records needed to set up a custom domain.
Verify Domain
Trigger DNS verification of a custom domain.
Get Setup Link
Build a one-click DNS setup link for the domain via the Domain Connect standard.
List Drafts
List drafts, most recent first.
Create Draft
Create a draft in an inbox for review or scheduled sending.
Get Draft
Get a draft with its full body, recipients and attachments.
Update Draft
Edit fields on an existing draft.
Delete Draft
Permanently delete a draft, cancelling any scheduled send.
Get Attachment
Get a download URL and metadata for one attachment of a draft.
Send Draft
Send an existing draft from its inbox.
List Drafts
List drafts, most recent first across every inbox in the organization.
Get Draft
Get a draft with its full body, recipients and attachments.
Get Attachment
Get a download URL and metadata for one attachment of a draft.
List Inbox Events
List label change events for an inbox.
List Inboxes
List the inboxes in the AgentMail organization.
Create Inbox
Create a new inbox (email address) for an agent.
Search Inboxes
Searches inboxes in the organization by address or display name, ranked by relevance.
Get Inbox
Get an inbox with its email address, display name and metadata.
Update Inbox
Update an inbox’s display name, status or metadata.
Delete Inbox
Permanently delete an inbox along with its messages, threads and drafts.
Authorize Inbox
Authorizes the AgentID sign-in a client is already waiting in, for the inbox in the path, and returns the ID of the pend…
List Messages
Lists messages in the inbox, most recent first.
Search Messages
Full-text search across messages in the inbox, ranked by relevance.
Get Message
Get a single message with its full text, HTML, headers and attachment metadata.
Update Message
Add or remove labels on a single message.
Delete Message
Permanently deletes a message.
Create Agent Armor Feedback
Tell us whether Agent Armor’s verdict on a message was right.
Release Agent Armor Message
Release a message Agent Armor held for review in hold mode: your agents are sent its message.received event, message.sec…
Batch Get Messages
Fetch metadata for up to 500 messages in one request.
Batch Update Messages
Apply one label change to up to 50 messages in a single request.
Get Attachment
Get a download URL and metadata for one attachment of a message.
Get Raw Message
Get a signed download URL for the raw .eml source of a message.
Send Message
Send a new email from an inbox.
Reply To Message
Reply to a message in an inbox, keeping it in the same thread.
Reply All Message
Reply to every recipient of a message in an inbox.
Forward Message
Forward a message from an inbox to new recipients.
List Threads
Lists threads in the inbox, most recent first.
Search Threads
Full-text search across threads in the inbox, ranked by relevance.
Get Thread
Get a thread with all of its messages.
Update Thread
Add or remove labels on a thread.
Delete Thread
Permanently deletes a thread and all of its messages.
Get Attachment
Get a download URL and metadata for one attachment in a thread.
List Threads
Lists threads, most recent first.
Search Threads
Full-text search across threads in the organization, ranked by relevance.
Get Thread
Get a thread with all of its messages.
Update Thread
Add or remove labels on a thread.
Delete Thread
Permanently deletes a thread and all of its messages.
Get Attachment
Get a download URL and metadata for one attachment in a thread.
Events
|
No tags found
21 events
Event
Description
Tags
Calendar Event Created Webhook
Processes AgentMail calendar.event.created events.
CalendarWebhooks
Calendar Event Updated Webhook
Processes AgentMail calendar.event.updated events.
CalendarWebhooks
Calendar Event Deleted Webhook
Processes AgentMail calendar.event.deleted events.
CalendarWebhooks
Calendar Event Responded Webhook
Processes AgentMail calendar.event.responded events.
CalendarWebhooks
Calendar Event Starting Webhook
Processes AgentMail calendar.event.starting events.
CalendarWebhooks
Calendar Event Ending Webhook
Processes AgentMail calendar.event.ending events.
CalendarWebhooks
Domain Verified Webhook
Processes AgentMail domain.verified events.
DomainsWebhooks
Webhook Delivery Acknowledgement
Acknowledges AgentMail deliveries that carry no event_type.
Webhooks
Message Received Webhook
Processes AgentMail message.received events.
MessagesWebhooks
Spam Message Received Webhook
Processes AgentMail message.received.spam events.
MessagesWebhooks
Blocked Message Received Webhook
Processes AgentMail message.received.blocked events.
MessagesWebhooks
Unauthenticated Message Received Webhook
Processes AgentMail message.received.unauthenticated events.
MessagesWebhooks
Message Sent Webhook
Processes AgentMail message.sent events.
MessagesWebhooks
Message Delivered Webhook
Processes AgentMail message.delivered events.
MessagesWebhooks
Message Bounced Webhook
Processes AgentMail message.bounced events.
MessagesWebhooks
Message Complained Webhook
Processes AgentMail message.complained events.
MessagesWebhooks
Message Rejected Webhook
Processes AgentMail message.rejected events.
MessagesWebhooks
Message Opened Webhook
Processes AgentMail message.opened events.
MessagesWebhooks
Message Security Completed Webhook
Processes AgentMail message.security.completed events.
Agent ArmorWebhooks
Message Security Review Webhook
Processes AgentMail message.security.review events.
Agent ArmorWebhooks
Message Security Override Webhook
Processes AgentMail message.security.override events.
Agent ArmorWebhooks