mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
70309fa005
* chore: add tips for HTTP email connector * chore: adopt suggestion Co-authored-by: Charles Zhao <charleszhao@silverhand.io> --------- Co-authored-by: Charles Zhao <charleszhao@silverhand.io>
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# HTTP email connector
|
|
|
|
The official Logto connector for HTTP email.
|
|
|
|
## Get started
|
|
|
|
The HTTP email connector allows you to send emails via HTTP call. To use the HTTP email connector, you'll need to have your own email service that expose an HTTP API for sending emails. Logto will call this API when it needs to send an email. For example, when a user registers, Logto will call the HTTP API to send a verification email.
|
|
|
|
## Set up HTTP email connector
|
|
|
|
To use the HTTP email connector, you need to set up an HTTP endpoint that Logto can call, and an optional authorization token for the endpoint.
|
|
|
|
> 💡 **Tip**
|
|
>
|
|
> Note that to prevent errors in authentication flow, the configured `endpoint` must return a 2xx response after receiving the webhook to inform Logto that it has received the notification to send the email.
|
|
>
|
|
> Meanwhile, in this scenario, you need to monitor email service to ensure successful email delivery. Alternatively, you can add monitoring to your email sending API to promptly detect email delivery failures.
|
|
|
|
## Payload
|
|
|
|
The HTTP email connector will send the following payload to the endpoint when it needs to send an email:
|
|
|
|
```json
|
|
{
|
|
"to": "foo@logto.io",
|
|
"type": "SignIn",
|
|
"payload": {
|
|
"code": "123456"
|
|
}
|
|
}
|
|
```
|
|
|
|
You can find all of the types in https://docs.logto.io/docs/recipes/configure-connectors/email-connector/configure-popular-email-service/#email-template, and the full type definition of `SendMessageData` in [connector-kit](https://github.com/logto-io/logto/tree/master/packages/toolkit/connector-kit/src/types/passwordless.ts).
|