-
-
Notifications
You must be signed in to change notification settings - Fork 439
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(connector): add readme of http email connector
- Loading branch information
Showing
1 changed file
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,27 @@ | ||
# HTTP email connector | ||
|
||
TBD | ||
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. | ||
|
||
## Payload | ||
|
||
The HTTP email connector will send the following payload to the endpoint when it needs to send an email: | ||
|
||
```json | ||
{ | ||
"to": "[email protected]", | ||
"type": "SignIn", | ||
"payload": { | ||
"code": "123456" | ||
} | ||
} | ||
``` | ||
|
||
You can find the type definition of `SendMessageData` in [connector-kit](../../toolkit/connector-kit/src/types/passwordless.ts). |