Skip to main content
Properties for SMTP connections are specified in the properties object when creating or updating a connection. All properties are nested within the connection request body.

​
Properties

​
smtpUrl
string
required
SMTP server hostname or fully qualified domain name. Example: smtp.gmail.com
​
smtpPort
integer
required
Port number for the SMTP server connection. for SSL.
​
smtpUsername
string
required
Username for authenticating to the SMTP server.
​
smtpPassword
object
required
Reference to a Prophecy secret containing the SMTP password.
  • When using the create connection API, the secret must be stored in Prophecy before creating the connection.
  • When using the create fabric API, replace this whole object with the string {{SECRET}}, which references the secret being created in parallel to the connection.