From 8027abae2770647639e9510cb256f0f2a15067d6 Mon Sep 17 00:00:00 2001 From: wangsijie Date: Thu, 19 Sep 2024 22:41:51 +0900 Subject: [PATCH] docs(connector): add readme of http email connector --- .../connectors/connector-http-email/README.md | 26 ++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/packages/connectors/connector-http-email/README.md b/packages/connectors/connector-http-email/README.md index 4479c45a006..23d215a21ec 100644 --- a/packages/connectors/connector-http-email/README.md +++ b/packages/connectors/connector-http-email/README.md @@ -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": "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).