Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

docs(connector): add readme of http email connector (#6603)

Browse source
This commit is contained in:
wangsijie 2024-09-23 14:17:34 +08:00 committed by GitHub
parent 9adbb31341
commit 6fddf6750c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
packages/connectors/connector-http-email/README.md
View file

@ -1,3 +1,27 @@
# HTTP email connector # 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": "foo@logto.io",
"type": "SignIn",
"payload": {
"code": "123456"
}
}
```
You can find the type definition of `SendMessageData` in [connector-kit](../../toolkit/connector-kit/src/types/passwordless.ts).