Flows API Menu
  • Globus Flows
  • Overview
  • Authentication and Authorization
  • Authoring Flows
  • Authoring Input Schemas
  • Permissions
  • Limits
  • Hosted Action Providers
    • Hello World
    • Globus Transfer - Transfer Task
    • Globus Transfer - Delete Task
    • Globus Transfer - Set Permission
    • Globus Transfer - List Directory Contents
    • Globus Transfer - Make Directory
    • Globus Transfer - Get Collection
    • Globus Search - Ingest Task
    • Globus Search - Delete Task
    • Send Notification Email
    • Wait For User Selection
    • Expression Evaluation
    • Datacite Mint
Skip to main content
Globus Docs
  • APIs
    Auth Compute Flows Globus Connect Server Groups Search Transfer Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data Command Line Interface Premium Storage Connectors Security Modern Research Data Portal
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus APIs
  3. Globus Flows
  4. Hosted Action Providers

Action Provider: Send Notification Email

URL: https://actions.globus.org/notification/notify

Scope: https://auth.globus.org/scopes/5fac2e64-c734-4e6b-90ea-ff12ddbf9653/notification_notify

Synchronous / Asynchronous: Synchronous

The Send Notification / Email action provider presently supports sending of email messages to a set of email addresses. The request to send the email contains the standard components of an email: sender, receiver(s), subject and body. The mimetype of the body may be specified so that either HTML or text formatted messages may be sent. The body also supports the notion of variable substitution or "templating". Values in the body may be specified with a dollar sign prefix ($), and when values are provided in the body_variables property of the request, the template value will be substituted with the corresponding value from the body_variables.

The other important component of the request to this action provider is the email sending credentials. Credentials are provided to allow the provider to communicate with the service used for sending the email. Presently, two modes of sending email are supported: SMTP and AWS SES. When SMTP is provided, the username, password and server hostname are required. When AWS SES is provided, the AWS access key, AWS access key secret and the AWS region must be provided. As this service is synchronous and stateless, the requester can be assured that these credentials will not be stored. The action provider will return success as long as the email service accepts the message. It cannot guarantee successful delivery of the message including an inability to deliver the message due to an improper recipient address.

Example Input with Complex Templating
{
  "notification_method": "email",
  "notification_priority": "high",
  "body_template": "<html><body><h1>Hello $Name</h1></body></html>",
  "body_mimetype": "text/html",
  "body_variables": {
    "Name": "Dude"
  },
  "destination": "user@globus.org",
  "sender": "user@globus.org",
  "subject": "Testing From CLI",
  "send_credentials": [
    {
      "credential_method": "email",
      "credential_type": "ses",
      "credential_value": {
        "aws_access_key_id": "SECRET",
        "aws_secret_access_key": "SECRET",
        "region_name": "us-east-1"
      }
    }
  ]
}
Example Input with Simple Formatting
{
  "body_mimetype": "text/html",
  "body_template": "Hello there",
  "destination": "DESTINATION@example.org",
  "notification_method": "any",
  "notification_priority": "high",
  "sender": "SENDER@example.org",
  "subject": "Testing Notification",
  "send_credentials": [
    {
      "credential_type": "ses",
      "credential_value": {
        "aws_access_key_id": "AWS_ACCESS_KEY_ID",
        "aws_secret_access_key": "AWS_SECRET_ACCESS_KEY",
        "region_name": "us-east-1"
      }
    }
  ]
}
  • Globus Flows
  • Overview
  • Authentication and Authorization
  • Authoring Flows
  • Authoring Input Schemas
  • Permissions
  • Limits
  • Hosted Action Providers
    • Hello World
    • Globus Transfer - Transfer Task
    • Globus Transfer - Delete Task
    • Globus Transfer - Set Permission
    • Globus Transfer - List Directory Contents
    • Globus Transfer - Make Directory
    • Globus Transfer - Get Collection
    • Globus Search - Ingest Task
    • Globus Search - Delete Task
    • Send Notification Email
    • Wait For User Selection
    • Expression Evaluation
    • Datacite Mint
© 2010- The University of Chicago Legal Privacy Accessibility