Skip to main content
WEBHOOK

Body

application/json
host
string
required

The SMTP host.

port
integer
required

465 (implicit TLS) or 587 (STARTTLS).

security
enum<string>
required

How the connection is encrypted.

Available options:
IMPLICIT_TLS,
STARTTLS
username
string
required

The SMTP login username.

from_address
string
required

The address code emails are sent from.

from_name
string | null
required

The name shown beside the From address; null shows the organization's name.

status
enum<string>
required

UNVERIFIED until a test code is entered back, VERIFIED once it is, FAILING when a live send fails for a reason the organization must fix.

Available options:
UNVERIFIED,
VERIFIED,
FAILING
created_at
string<date-time>
required

When the sender was saved.

__event__
WebhookMetadata · object
has_password
boolean
default:true

Whether a password is stored.

verified_at
string<date-time> | null

When the sender was last verified.

last_tested_at
string<date-time> | null

When a test send last settled.

last_error_kind
enum<string> | null

How the last failed send ended.

Available options:
SENT,
REJECTED_RECIPIENT,
REJECTED_SENDER,
AUTH_FAILED,
DEFERRED,
DEFERRED_RECIPIENT,
UNREACHABLE,
TIMEOUT
updated_at
string<date-time> | null

When the sender last changed.

Response

Successful Response