agent

package

Go to main page

Versions in this module

v0

v0.4.0

Jun 4, 2026

v0.3.0

Jun 3, 2026

Changes in this version

+ const LabelSystemPrefix

+ const MaxLabelLength

+ const MaxLabelsPerOp

type API

+ func (a *API) SetBillingHookURL(s string)

+ func (a *API) SetEnforcer(e limits.Enforcer)

+ func (a *API) SetIdempotencyStore(s *idempotency.Store)

+ func (a *API) SetInternalAPISecret(s string)

+ func (a *API) SetMetrics(m telemetry.Metrics)

+ func (a *API) SetOAuthProvider(p fosite.OAuth2Provider)

+ func (a *API) SetOAuthStorage(s *oauth.Storage)

+ func (a *API) SetOutbox(o webhookpub.Outbox)

+ func (a *API) SetPoolForEvents(p *pgxpool.Pool)

+ func (a *API) SetPublisher(p webhookpub.Publisher)

+ func (a *API) SetSubscriberStore(s *webhook.SubscriberStore)

+ func (a *API) SetUsageStore(s *usage.Store)

+ type ConversationDetail struct

+ Labels []string

+ Messages []MessageSummary

+ Participants []string

+ type ConversationSummary struct

+ ConversationID string

+ FirstMessageAt string

+ HasUnread bool

+ InboundCount int

+ LastMessageAt string

+ LatestSender string

+ LatestSubject string

+ MessageCount int

+ OutboundCount int

+ type CreateSigningSecretRequest struct

+ Name string

+ type CreateSigningSecretResponse struct

+ CreatedAt string

+ ID string

+ Name string

+ Secret string

+ SecretPrefix string

+ type CreateWebhookRequest struct

+ Description string

+ Events []string

+ Filters *WebhookFilters

+ URL string

type DNSRecords

+ DKIM DNSRecord

+ type DeliveryStatus struct

+ Delivered int

+ Failed int

+ MatchedWebhooks int

+ Pending int

type DomainInfo

+ AgentCount int

+ IsPrimary bool

+ LastCheckedAt *time.Time

+ type ForwardMessageRequest struct

+ Attachments []Attachment

+ BCC []string

+ Body string

+ CC []string

+ ConversationID string

+ HTMLBody string

+ To []string

+ type ForwardRequest struct

+ Attachments []outbound.Attachment

+ BCC []string

+ Body string

+ CC []string

+ ConversationID string

+ HTMLBody string

+ To []string

+ type LimitsCaps struct

+ MaxAgents int

+ MaxDomains int

+ MaxMessagesMonth int

+ MaxStorageBytes int64

+ type LimitsInfo struct

+ Limits LimitsCaps

+ PlanCode string

+ UpgradeURL string

+ Usage LimitsUsage

+ type LimitsUsage struct

+ Agents int

+ Domains int

+ MessagesMonth int

+ StorageBytes int64

+ type ListConversationsResponse struct

+ Conversations []ConversationSummary

+ type ListEventsResponse struct

+ Events []WebhookEvent

+ NextToken string

+ type ListSigningSecretsResponse struct

+ Secrets []SigningSecretSummary

+ type ListWebhookDeliveriesResponse struct

+ Deliveries []WebhookDeliveryResponse

+ type ListWebhooksResponse struct

+ Webhooks []WebhookResponse

type MessageDetail

+ CC []string

+ Labels []string

+ Recipient string

+ ReplyTo []string

type MessageSummary

+ CC []string

+ Direction string

+ HITLStatus string

+ Labels []string

+ Recipient string

+ ReplyTo []string

+ SizeBytes int

+ WebhookError string

+ WebhookStatus string

+ type OAuthClientPublicMetadata struct

+ ClientID string

+ ClientIDIssuedAt int64

+ ClientName string

+ RedirectURIs []string

+ Scopes []string

+ type OAuthError struct

+ Error string

+ ErrorDescription string

+ type OAuthMetadata struct

+ AuthorizationEndpoint string

+ AuthorizationResponseIssParameterSupported bool

+ CodeChallengeMethodsSupported []string

+ GrantTypesSupported []string

+ Issuer string

+ RegistrationEndpoint string

+ ResponseModesSupported []string

+ ResponseTypesSupported []string

+ RevocationEndpoint string

+ RevocationEndpointAuthMethodsSupported []string

+ ScopesSupported []string

+ TokenEndpoint string

+ TokenEndpointAuthMethodsSupported []string

+ type OAuthRegisterRequest struct

+ ClientName string

+ GrantTypes []string

+ RedirectURIs []string

+ ResponseTypes []string

+ Scope string

+ TokenEndpointAuthMethod string

+ type OAuthRegisterResponse struct

+ ClientID string

+ ClientIDIssuedAt int64

+ ClientName string

+ GrantTypes []string

+ RedirectURIs []string

+ ResponseTypes []string

+ Scope string

+ TokenEndpointAuthMethod string

type PendingMessageDetail

+ InboundContext *PendingMessageInboundContext

+ ReviewedByName *string

+ ReviewedByUserID *string

+ type PendingMessageInboundContext struct

+ AuthHeaders map[string]string

+ CreatedAt string

+ Sender string

+ Subject string

+ type RedeliverDeliveryResult struct

+ DeliveryID string

+ Reason string

+ Status string

+ WebhookID string

+ type RedeliverRequest struct

+ WebhookID string

+ type RedeliverResponse struct

+ Deliveries []RedeliverDeliveryResult

+ DeliveryID string

+ EventID string

+ Status string

+ WebhookID string

+ type RedeliverSinceRequest struct

+ Since string

+ type RedeliverSinceResponse struct

+ Scheduled int

+ Since string

+ SkippedAlreadyPending int

+ WebhookID string

+ type RotateWebhookSecretResponse struct

+ PreviousSecretExpiresAt string

+ SigningSecret string

+ type SigningSecretSummary struct

+ CreatedAt string

+ ID string

+ LastSignedAt *string

+ Name string

+ Secret string

+ SecretPrefix string

+ type TestWebhookRequest struct

+ Data map[string]interface{}

+ Event string

+ type TestWebhookResponse struct

+ DeliveryID string

+ type UpdateDomainRequest struct

+ IsPrimary *bool

+ type UpdateMessageRequest struct

+ AddLabels []string

+ RemoveLabels []string

+ type UpdateMessageResponse struct

+ Labels []string

+ MessageID string

+ type UpdateWebhookRequest struct

+ Description *string

+ Enabled *bool

+ Events *[]string

+ Filters *WebhookFilters

+ URL *string

type VerifyDomainResponse

+ DKIM string

+ MX string

+ SPF string

type WebSocketNotification

+ Recipient string

+ type WebhookDeliveryResponse struct

+ Attempts int

+ CreatedAt string

+ EventType string

+ ID string

+ LastAttemptAt string

+ LastError string

+ LastStatusCode *int

+ NextRetryAt string

+ Status string

+ type WebhookEvent struct

+ AgentID *string

+ ConversationID *string

+ CreatedAt string

+ Data map[string]interface{}

+ DeliveryStatus *DeliveryStatus

+ ID string

+ MessageID *string

+ SchemaVersion int

+ Status string

+ Type string

+ type WebhookFilters struct

+ AgentIDs []string

+ ConversationIDs []string

+ Labels []string

type WebhookPayload

+ CC []string

+ Recipient string

+ type WebhookResponse struct

+ AutoDisabledAt string

+ CreatedAt string

+ Description string

+ Enabled bool

+ Events []string

+ Filters WebhookFilters

+ ID string

+ LastDeliveredAt string

+ PreviousSecretExpiresAt string

+ SigningSecret string

+ URL string

v0.2.0

Apr 26, 2026

Changes in this version

+ func ValidateWebhookURL(rawURL string) error

+ type API struct

+ func NewAPI(store *identity.Store, sender *outbound.Sender, smtpRelay *outbound.SMTPRelay, ...) *API

+ func (a *API) RegisterRoutes(r *mux.Router)

+ func (a *API) RegisterWSRoute(r *mux.Router, handle http.HandlerFunc)

+ func (a *API) SetApprovalSigner(s *approvaltoken.Signer)

+ func (a *API) SetNotifier(n *hitlnotify.Notifier)

+ type AgentInfo struct

+ AgentMode string

+ CreatedAt time.Time

+ Domain string

+ DomainVerified bool

+ Email string

+ HITLEnabled bool

+ HITLExpirationAction string

+ HITLTTLSeconds int

+ ID string

+ Name string

+ WebhookURL string

+ type ApprovePendingMessageRequest struct

+ Attachments []Attachment

+ BCC []string

+ BodyHTML *string

+ BodyText *string

+ CC []string

+ Subject *string

+ To []string

+ type ApprovePendingMessageResponse struct

+ Edited bool

+ MessageID string

+ Method string

+ ProviderMessageID string

+ Status string

+ type Attachment = outbound.Attachment

+ type AuthHeaders struct

+ Delegation string

+ DomainCheck string

+ EntityType string

+ Sender string

+ Signature string

+ Timestamp string

+ Verified string

+ type DNSRecord struct

+ Host string

+ Priority *int

+ Value string

+ type DNSRecords struct

+ MX DNSRecord

+ TXT DNSRecord

+ type DeleteUserDataResult = identity.DeleteUserDataResult

+ type DeploymentInfo struct

+ PublicURL string

+ SharedDomain string

+ SlugRegistrationEnabled bool

+ type DomainInfo struct

+ CreatedAt time.Time

+ DNSRecords DNSRecords

+ Domain string

+ VerificationToken string

+ Verified bool

+ VerifiedAt *time.Time

+ type ListAgentsResponse struct

+ Agents []AgentInfo

+ type ListDomainsResponse struct

+ Domains []DomainInfo

+ type ListMessagesResponse struct

+ Messages []MessageSummary

+ NextToken string

+ type ListPendingMessagesResponse struct

+ Messages []PendingMessageSummary

+ type MessageDetail struct

+ AuthHeaders map[string]string

+ ConversationID string

+ CreatedAt string

+ From string

+ MessageID string

+ RawMessage string

+ Status string

+ Subject string

+ To string

+ type MessageSummary struct

+ ConversationID string

+ CreatedAt string

+ From string

+ MessageID string

+ Status string

+ Subject string

+ To string

+ type PendingMessageDetail struct

+ Attachments []Attachment

+ BodyHTML string

+ BodyText string

+ Edited bool

+ EmailMessageID string

+ Method string

+ ProviderMessageID string

+ RejectionReason string

+ ReviewedAt string

+ type PendingMessageSummary struct

+ AgentID string

+ ApprovalExpiresAt string

+ BCC []string

+ CC []string

+ ConversationID string

+ CreatedAt time.Time

+ Direction string

+ ID string

+ Status string

+ Subject string

+ To []string

+ Type string

+ type RegisterAgentRequest struct

+ AgentMode string

+ Email string

+ Name string

+ Slug string

+ WebhookURL string

+ type RegisterAgentResponse struct

+ Domain string

+ Email string

+ ID string

+ type RegisterDomainRequest struct

+ Domain string

+ type RegisterDomainResponse = DomainInfo

+ type RejectPendingMessageRequest struct

+ Reason string

+ type RejectPendingMessageResponse struct

+ MessageID string

+ RejectionReason string

+ Status string

+ type ReplyRequest struct

+ Attachments []outbound.Attachment

+ BCC []string

+ Body string

+ CC []string

+ ConversationID string

+ HTMLBody string

+ ReplyAll bool

+ type ReplyToMessageRequest struct

+ Attachments []Attachment

+ BCC []string

+ Body string

+ CC []string

+ ConversationID string

+ HTMLBody string

+ ReplyAll bool

+ type SendEmailRequest struct

+ Attachments []Attachment

+ BCC []string

+ Body string

+ CC []string

+ ConversationID string

+ From string

+ HTMLBody string

+ Subject string

+ To []string

+ type SendEmailResponse struct

+ ApprovalExpiresAt string

+ MessageID string

+ Method string

+ Status string

+ type UpdateAgentRequest struct

+ AgentMode *string

+ HITLEnabled *bool

+ HITLExpirationAction *string

+ HITLTTLSeconds *int

+ WebhookURL *string

+ type UserExport = identity.UserExport

+ type VerifyDomainResponse struct

+ Domain string

+ Verified bool

+ VerifiedAt *time.Time

+ type WebSocketNotification struct

+ ConversationID string

+ From string

+ MessageID string

+ ReceivedAt time.Time

+ Subject string

+ To string

+ type WebhookPayload struct

+ AuthHeaders map[string]string

+ ConversationID string

+ From string

+ MessageID string

+ RawMessage []byte

+ ReceivedAt time.Time

+ To string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL