For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
contact@agentmail.ccDiscord
DocumentationAPI ReferenceKnowledge BaseChangelog
DocumentationAPI ReferenceKnowledge BaseChangelog
  • API Reference
      • WSSConnect
LogoLogo
contact@agentmail.ccDiscord
API ReferenceWebsockets

Connect

WSS
/v0
Handshake
URLwss://ws.agentmail.to/v0
MethodGET
Status101 Switching Protocols
Messages
Was this page helpful?
Previous

List Domains

Next
Built with

Handshake

WSS
/v0

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

api_keystringOptional
Your API key. Required if Authorization header is not set.

Send

subscribeobjectRequired

Receive

subscribedobjectRequired
OR
message_receivedobjectRequired
OR
message_sentobjectRequired
OR
message_deliveredobjectRequired
OR
message_bouncedobjectRequired
OR
message_complainedobjectRequired
OR
message_rejectedobjectRequired
OR
domain_verifiedobjectRequired
OR
errorobjectRequired