DeliveryOutcome

What perform knows about a send: sent, or a delivery error that says whether anything may have reached the provider.

A union discriminated by status.

sent

status"sent"required

"sent": the provider accepted the message.

platform_refstringrequired

The provider's id for the sent message, a non-empty string. The host records it as the send's receipt.

delivery_error

status"delivery_error"required

"delivery_error": the send failed or its outcome is unknown.

kind"rate_limited" | "transient" | "permanent"required

rate_limited, transient or permanent. When nothing was sent, the TypeScript host retries rate_limited and transient up to 3 attempts in total; the Python host, and either host on permanent, records the reply as not sent.

sent"definite_not_sent" | "outcome_unknown"required

definite_not_sent when you can prove nothing reached the provider; outcome_unknown otherwise. An unknown outcome is never re-sent: the host reconciles it by dedup window or lookup, else parks it.

Edit on GitHub

On this page