AptlyStar

Gmail

Available Gmail triggers for automating workflows

Gmail provides 1 trigger for automating workflows based on events.

All triggers below are polling-based — they check for new data on a schedule rather than receiving push notifications.

Triggers

Gmail Email Trigger

Triggers when new emails are received in Gmail (requires Gmail credentials)

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesThis trigger requires google email credentials to access your account.
labelIdsstringNoChoose which Gmail labels to monitor. Leave empty to monitor all emails.
labelFilterBehaviorstringYesInclude only emails with selected labels, or exclude emails with selected labels
searchQuerystringNoOptional Gmail search query to filter emails. Use the same format as Gmail search box (e.g.,
markAsReadbooleanNoAutomatically mark emails as read after processing
includeAttachmentsbooleanNoDownload and include email attachments in the trigger payload

Output

ParameterTypeDescription
emailobjectemail output from the tool
↳ idstringGmail message ID
↳ threadIdstringGmail thread ID
↳ subjectstringEmail subject line
↳ fromstringSender email address
↳ tostringRecipient email address
↳ ccstringCC recipients
↳ datestringEmail date in ISO format
↳ bodyTextstringPlain text email body
↳ bodyHtmlstringHTML email body
↳ labelsstringEmail labels array
↳ hasAttachmentsbooleanWhether email has attachments
↳ attachmentsfile[]Array of email attachments as files (if includeAttachments is enabled)
timestampstringEvent timestamp

On this page