Skip to content

Commit d265a87

Browse files
jacobovidaljacobovidal
authored
Add send email docs (#316)
* Add send email docs * Remove empty space * Update style
1 parent f8dffe7 commit d265a87

File tree

8 files changed

+66
-34
lines changed

8 files changed

+66
-34
lines changed

‎main/docs/customize/forms/flows/integrations/auth0.mdx‎

Lines changed: 58 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
2-
description: Learn how to configure your Auth0 flow actions to retrieve and update
3-
user's profile information or create new users.
2+
description: Learn how to configure your Auth0 pre-built flow actions to make requests against the Management API or send custom notifications.
43
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
54
'og:title': Auth0
65
'og:url': https://auth0.com/docs/
76
permalink: auth0
87
title: Auth0
9-
'twitter:description': Learn how to configure your Auth0 flow actions to retrieve
10-
and update user's profile information or create new users.
8+
'twitter:description': Learn how to configure your Auth0 pre-built flow actions to make requests against the Management API or send custom notifications.
119
'twitter:title': Auth0
1210
---
13-
This list of Auth0 actions allows you to get, create, and update users.
1411

15-
## Configure your Vault connection
12+
## Management API
1613

17-
To configure a Vault connection for your Auth0 actions, you will need to [create a Machine-to-Machine](/docs/get-started/auth0-overview/create-applications/machine-to-machine-apps) application and use **Tenant domain, <Tooltip tip="Client ID: Identification value given to your registered resource from Auth0." cta="View Glossary" href="/docs/glossary?term=Client+ID">Client ID</Tooltip> and <Tooltip tip="Client ID: Identification value given to your registered resource from Auth0." cta="View Glossary" href="/docs/glossary?term=Client+Secret">Client Secret</Tooltip>**:
14+
### Configure your Vault connection with Management API
15+
16+
To configure a Vault connection for your Auth0 Actions, you will need to [create a Machine-to-Machine](/docs/get-started/auth0-overview/create-applications/machine-to-machine-apps) application and use **Tenant domain, <Tooltip tip="Client ID: Identification value given to your registered resource from Auth0." cta="View Glossary" href="/docs/glossary?term=Client+ID">Client ID</Tooltip> and <Tooltip tip="Client ID: Identification value given to your registered resource from Auth0." cta="View Glossary" href="/docs/glossary?term=Client+Secret">Client Secret</Tooltip>**:
1817

1918
<Frame>![](/docs/images/cdy7uua7fh8z/1IPtH5hD6QTRXsySyo2Ovr/3562828624e2fd4f308b6eb3b5042f34/auth0-vault-connection.png)</Frame>
2019

@@ -24,7 +23,7 @@ Remember to authorize your Machine-to-Machine application to access the Manageme
2423

2524
</Warning>
2625

27-
## Create user
26+
### Create user
2827

2928
<Warning>
3029
Create User doesn't support interactions using canonical domain when combined with [Multiple Custom Domains](/docs/customize/custom-domains/multiple-custom-domains.mdx) during Early Access. To learn more, read [Product Release Stages](/docs/troubleshoot/product-lifecycle/product-release-stages.mdx).
@@ -34,7 +33,7 @@ Create a user.
3433

3534
<Frame>![](/docs/images/cdy7uua7fh8z/6MQIKf2IpTtI2g7d5Pwn7u/222ec746cf9c0c1003d18ba4c0aa451e/create_user.png)</Frame>
3635

37-
### Input settings
36+
#### Input settings
3837

3938
<table class="table">
4039
<thead>
@@ -51,17 +50,17 @@ Create a user.
5150
</tbody>
5251
</table>
5352

54-
### Output settings
53+
#### Output object
5554

56-
You can find the expected response and status codes at [Create a user](https://auth0.com/docs/api/management/v2/users/post-users#response-messages) API documentation.
55+
Review [Create a user](https://auth0.com/docs/api/management/v2/users/post-users#response-messages) for expected response and status code.
5756

58-
## Get user
57+
### Get user
5958

6059
Retrieve user details.
6160

6261
<Frame>![](/docs/images/cdy7uua7fh8z/3GoNZsXOvMTYRtMQNj00mm/6e92d94cee7b165479c688358a5df242/Screenshot_2024-11-18_at_16.31.49.png)</Frame>
6362

64-
### Input settings
63+
#### Input settings
6564

6665
<table class="table">
6766
<thead>
@@ -73,22 +72,22 @@ Retrieve user details.
7372
<tbody>
7473
<tr>
7574
<td>User ID</td>
76-
<td>ID of the user to retrieve. To learn more, read \<a api="" auth0.com="" docs="" get-users-by-id="" https:="" management="" users="" v2="">Get a user\</a> API documentation. </td>
75+
<td>ID of the user to retrieve. To learn more, read [Get a user](https://auth0.com/docs/api/management/v2/users/get-users-by-id) API documentation. </td>
7776
</tr>
7877
</tbody>
7978
</table>
8079

81-
### Output settings
80+
#### Output object
8281

83-
You can find the expected response and status codes at [Get a user](https://auth0.com/docs/api/management/v2/users/get-users-by-id#response-messages) API documentation.
82+
Review [Get a user](https://auth0.com/docs/api/management/v2/users/get-users-by-id#response-messages) for expected response and status code.
8483

85-
## Update user
84+
### Update user
8685

8786
Update a user.
8887

8988
<Frame>![](/docs/images/cdy7uua7fh8z/3tymSpaeod6EksWRJp1sge/1122b244d756d754fe41baac209a132b/Screenshot_2024-11-18_at_16.49.56.png)</Frame>
9089

91-
### Input settings
90+
#### Input settings
9291

9392
<table class="table">
9493
<thead>
@@ -109,17 +108,17 @@ Update a user.
109108
</tbody>
110109
</table>
111110

112-
### Output settings
111+
#### Output object
113112

114113
You can find the expected response and status codes at [Update a user](https://auth0.com/docs/api/management/v2/users/patch-users-by-id#response-messages) API documentation.
115114

116-
## Custom API Request
115+
### Custom API request
117116

118117
Send a custom API request to Auth0 API endpoints.
119118

120119
<Frame>![Dashboard > Customize > Flows > Integrations > Auth0](/docs/images/cdy7uua7fh8z/66uV9iuhwfnXUdE1quLOyx/2ae3ff26335acbcd172cbb40618a5a90/Screenshot_2025-01-24_at_18.50.26.png)</Frame>
121120

122-
### Input settings
121+
#### Input settings
123122

124123
<table class="table">
125124
<thead>
@@ -170,6 +169,42 @@ Available HTTP methods include:
170169
</tbody>
171170
</table>
172171

173-
### Output settings
172+
#### Output object
173+
174+
Review [Auth0 Management API](https://auth0.com/docs/api/management/v2/introduction) for expected responses and status codes.
175+
176+
## Notifications
177+
178+
### Send email
179+
180+
Send a custom email using your [configured email provider.](https://auth0.com/docs/customize/email/configure-a-custom-email-provider)
181+
182+
<Warning>
183+
A [Custom Email Provider](https://auth0.com/docs/customize/email/configure-a-custom-email-provider) must be enabled before using this action.
184+
</Warning>
185+
186+
<Frame>![](/docs/images/forms/flows/integrations/auth0-notifications-send-email.png)</Frame>
187+
188+
#### Input settings
189+
190+
| Parameter | Description |
191+
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
192+
| Use custom sender email | By default, we will use the sender email you have configured in your custom email provider settings. Enable this option if you want to use a different sender email or name. |
193+
| Recipient email | The recipient’s email |
194+
| Subject | The email subject |
195+
| Custom variable | Add custom variables to be inserted in your email template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`. |
196+
| Message | Email message in HTML format using Liquid syntax. You can use [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables) or custom ones using `{{custom_vars.your_variable_key}}` syntax. |
197+
198+
#### Output object
199+
200+
| Property | Type | Description |
201+
|-----------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
202+
| success | Boolean | Indicates if the email was successfully queued to be sent, regardless of whether the delivery failed or not. |
203+
204+
#### Output object example
174205

175-
You can find the expected response and status codes at [Auth0 Management API](https://auth0.com/docs/api/management/v2/introduction) documentation.
206+
```json
207+
{
208+
"success": true
209+
}
210+
```

‎main/docs/customize/forms/flows/integrations/logic.mdx‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Adds a conditional action with True / False branches to customize the behavior o
3737
</tbody>
3838
</table>
3939

40-
### Output response
40+
### Output object
4141

4242
<table class="table">
4343
<thead>
@@ -66,9 +66,6 @@ Adds a conditional action with True / False branches to customize the behavior o
6666

6767

6868

69-
70-
71-
7269
## Store shared variable
7370

7471
Stores variables in a private state that is available in your form and across its flows.
@@ -164,7 +161,7 @@ Maps an input variable to an output based on its values.
164161
</tbody>
165162
</table>
166163

167-
### Output response
164+
### Output object
168165

169166
<table class="table">
170167
<thead>

‎main/docs/customize/forms/flows/integrations/mailjet.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,6 @@ Send an email using Mailjet as the email provider.
8383
</tbody>
8484
</table>
8585

86-
### Output settings
86+
### Output object
8787

8888
You can find the expected response and status codes at [Mailjet's documentation](https://dev.mailjet.com/email/reference/send-emails/).

‎main/docs/customize/forms/flows/integrations/sendgrid.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,6 @@ Send an email using SendGrid as the email provider.
7171
</tbody>
7272
</table>
7373

74-
### Output settings
74+
### Output object
7575

7676
You can find the expected response and status codes at [SendGrid's documentation](https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send).

‎main/docs/customize/forms/flows/integrations/telegram.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ Send a messages to a Telegram chat
4343
</tbody>
4444
</table>
4545

46-
### Output settings
46+
### Output object
4747

4848
You can find the expected response and status codes at [Telegram's documentation](https://core.telegram.org/method/messages.sendMessage).

‎main/docs/customize/forms/flows/integrations/twilio.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Sends an SMS.
4949
</tbody>
5050
</table>
5151

52-
### Output settings
52+
### Output object
5353

5454
You can find all the expected status codes at [Twilio's documentation](https://www.twilio.com/docs/messaging/api/message-resource#message-status-values).
5555

@@ -88,6 +88,6 @@ TwiML payload (required)
8888
</tbody>
8989
</table>
9090

91-
### Output settings
91+
### Output object
9292

9393
You can find all the expected status codes at [Twilio's documentation](https://www.twilio.com/docs/voice/twiml).

‎main/docs/customize/forms/flows/integrations/whatsapp.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,6 @@ The content of the message object will differ based on the selected message type
7070
</tbody>
7171
</table>
7272

73-
### Output settings
73+
### Output object
7474

7575
You can find all expected status codes at [Facebook's documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes).

‎main/docs/images/forms/flows/integrations/auth0-notifications-send-email.png‎

80.6 KB
Loading

0 commit comments

Comments
 (0)