{"admin_contact":"support@globus.org","administered_by":[],"api_version":"1.0","description":null,"event_types":null,"globus_auth_scope":"https://auth.globus.org/scopes/5fac2e64-c734-4e6b-90ea-ff12ddbf9653/notification_notify","input_schema":{"definitions":{"AWSRegion":{"description":"An enumeration.","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ap-east-1","ap-south-1","ap-northeast-1","ap-northeast-3","ap-northeast-2","ap-southeast-1","ap-southeast-2","ca-central-1","eu-central-1","eu-west-1","eu-west-2","eu-west-3","eu-north-1","me-south-1","sa-east-1"],"title":"AWSRegion","type":"string"},"NotificationPriority":{"description":"An enumeration.","enum":["low","medium","high"],"title":"NotificationPriority","type":"string"},"SESCredential":{"properties":{"aws_access_key_id":{"title":"Aws Access Key Id","type":"string"},"aws_secret_access_key":{"title":"Aws Secret Access Key","type":"string"},"region_name":{"$ref":"#/definitions/AWSRegion"}},"required":["aws_access_key_id","aws_secret_access_key","region_name"],"title":"SESCredential","type":"object"},"SESCredentialType":{"description":"A credential type representing an SES based notification credential.","properties":{"credential_method":{"description":"An identifier which can be used put in 'notification_method' to exclusively use a specific credential for notifications.","title":"credential_method","type":"string"},"credential_type":{"default":"ses","enum":["ses"],"title":"Credential Type","type":"string"},"credential_value":{"allOf":[{"$ref":"#/definitions/SESCredential"}],"description":"SES specific credentials.","title":"credential_value"}},"required":["credential_value"],"title":"SESCredentialType","type":"object"},"SMTPCredential":{"properties":{"hostname":{"title":"Hostname","type":"string"},"password":{"title":"Password","type":"string"},"port":{"title":"Port","type":"integer"},"username":{"title":"Username","type":"string"}},"required":["hostname","password","username"],"title":"SMTPCredential","type":"object"},"SMTPCredentialType":{"description":"A credential type representing an SMTP based notification credential.","properties":{"credential_method":{"description":"An identifier which can be used put in 'notification_method' to exclusively use a specific credential for notifications.","title":"credential_method","type":"string"},"credential_type":{"default":"smtp","enum":["smtp"],"title":"Credential Type","type":"string"},"credential_value":{"allOf":[{"$ref":"#/definitions/SMTPCredential"}],"description":"SMTP specific credentials.","title":"credential_value"}},"required":["credential_value"],"title":"SMTPCredentialType","type":"object"}},"description":"For more details on this ActionProvider and its usage, visit\nhttps://globus-automate-client.readthedocs.io/en/latest/globus_action_providers.html#send-notification-email","examples":[{"body_mimetype":"text/html","body_template":"

Hello $Name

","body_variables":{"Name":"Dude"},"destination":"you@globus.org","notification_method":"email","notification_priority":"high","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"}}],"sender":"me@globus.org","subject":"Example Notification Action body"},{"body_mimetype":"text/html","body_template":"Hello there","destination":"DESTINATION@example.org","notification_method":"any","notification_priority":"high","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"}}],"sender":"SENDER@example.org","subject":"Testing Notification"}],"properties":{"body_mimetype":{"description":"Explicitly set the notification's mimetype to send HTML or text formatted messages.","title":"body_mimetype","type":"string"},"body_template":{"description":"A string template that will have the contents of 'body_variables' interpolated into itself. Notification-type specific markup is allowed.","title":"body_template","type":"string"},"body_variables":{"additionalProperties":{"type":"string"},"description":"A mapping of substitutions to make within the 'body_template'. Anywhere in the 'body_template' where '$' appears, the value for key will be substituted.","title":"body_variables","type":"object"},"destination":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array","uniqueItems":true}],"description":"The notification recipient(s).","title":"destination"},"notification_method":{"default":"any","description":"Indicate one specific 'credential_method' to use in this notification.","title":"notification_method","type":"string"},"notification_priority":{"allOf":[{"$ref":"#/definitions/NotificationPriority"}],"default":"low","description":"The priority for the notification.","title":"notification_priority"},"send_credentials":{"description":"The credentials to use for sending the notification(s).","items":{"anyOf":[{"$ref":"#/definitions/SMTPCredentialType"},{"$ref":"#/definitions/SESCredentialType"}]},"minItems":1,"title":"send_credentials","type":"array"},"sender":{"description":"The notification sender.","title":"sender","type":"string"},"subject":{"description":"The notification subject.","title":"subject","type":"string"}},"required":["sender","subject","destination","body_template","send_credentials"],"title":"Globus Notification Action Provider Schema","type":"object"},"keywords":null,"log_supported":false,"maximum_deadline":"P30D","runnable_by":["all_authenticated_users"],"subtitle":"An Action for sending notifications to users.","synchronous":true,"title":"Notification","types":["ACTION"],"visible_to":["public"]}