diff --git a/main/docs/customize/forms/flows/integrations/auth0.mdx b/main/docs/customize/forms/flows/integrations/auth0.mdx index 23c1cf97a..3c60767e3 100644 --- a/main/docs/customize/forms/flows/integrations/auth0.mdx +++ b/main/docs/customize/forms/flows/integrations/auth0.mdx @@ -1,20 +1,19 @@ --- -description: Learn how to configure your Auth0 flow actions to retrieve and update - user's profile information or create new users. +description: Learn how to configure your Auth0 pre-built flow actions to make requests against the Management API or send custom notifications. 'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png 'og:title': Auth0 'og:url': https://auth0.com/docs/ permalink: auth0 title: Auth0 -'twitter:description': Learn how to configure your Auth0 flow actions to retrieve - and update user's profile information or create new users. +'twitter:description': Learn how to configure your Auth0 pre-built flow actions to make requests against the Management API or send custom notifications. 'twitter:title': Auth0 --- -This list of Auth0 actions allows you to get, create, and update users. -## Configure your Vault connection +## Management API -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, Client ID and Client Secret**: +### Configure your Vault connection with Management API + +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, Client ID and Client Secret**: ![](/docs/images/cdy7uua7fh8z/1IPtH5hD6QTRXsySyo2Ovr/3562828624e2fd4f308b6eb3b5042f34/auth0-vault-connection.png) @@ -24,7 +23,7 @@ Remember to authorize your Machine-to-Machine application to access the Manageme -## Create user +### Create user 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. ![](/docs/images/cdy7uua7fh8z/6MQIKf2IpTtI2g7d5Pwn7u/222ec746cf9c0c1003d18ba4c0aa451e/create_user.png) -### Input settings +#### Input settings @@ -51,17 +50,17 @@ Create a user.
-### Output settings +#### Output object -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. +Review [Create a user](https://auth0.com/docs/api/management/v2/users/post-users#response-messages) for expected response and status code. -## Get user +### Get user Retrieve user details. ![](/docs/images/cdy7uua7fh8z/3GoNZsXOvMTYRtMQNj00mm/6e92d94cee7b165479c688358a5df242/Screenshot_2024-11-18_at_16.31.49.png) -### Input settings +#### Input settings @@ -73,22 +72,22 @@ Retrieve user details. - +
User IDID of the user to retrieve. To learn more, read \Get a user\ API documentation. 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.
-### Output settings +#### Output object -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. +Review [Get a user](https://auth0.com/docs/api/management/v2/users/get-users-by-id#response-messages) for expected response and status code. -## Update user +### Update user Update a user. ![](/docs/images/cdy7uua7fh8z/3tymSpaeod6EksWRJp1sge/1122b244d756d754fe41baac209a132b/Screenshot_2024-11-18_at_16.49.56.png) -### Input settings +#### Input settings @@ -109,17 +108,17 @@ Update a user.
-### Output settings +#### Output object 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. -## Custom API Request +### Custom API request Send a custom API request to Auth0 API endpoints. ![Dashboard > Customize > Flows > Integrations > Auth0](/docs/images/cdy7uua7fh8z/66uV9iuhwfnXUdE1quLOyx/2ae3ff26335acbcd172cbb40618a5a90/Screenshot_2025-01-24_at_18.50.26.png) -### Input settings +#### Input settings @@ -170,6 +169,42 @@ Available HTTP methods include:
-### Output settings +#### Output object + +Review [Auth0 Management API](https://auth0.com/docs/api/management/v2/introduction) for expected responses and status codes. + +## Notifications + +### Send email + +Send a custom email using your [configured email provider.](https://auth0.com/docs/customize/email/configure-a-custom-email-provider) + + +A [Custom Email Provider](https://auth0.com/docs/customize/email/configure-a-custom-email-provider) must be enabled before using this action. + + +![](/docs/images/forms/flows/integrations/auth0-notifications-send-email.png) + +#### Input settings + +| Parameter | Description | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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. | +| Recipient email | The recipient’s email | +| Subject | The email subject | +| Custom variable | Add custom variables to be inserted in your email template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`. | +| 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. | + +#### Output object + +| Property | Type | Description | +|-----------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| success | Boolean | Indicates if the email was successfully queued to be sent, regardless of whether the delivery failed or not. | + +#### Output object example -You can find the expected response and status codes at [Auth0 Management API](https://auth0.com/docs/api/management/v2/introduction) documentation. \ No newline at end of file +```json +{ + "success": true +} +``` \ No newline at end of file diff --git a/main/docs/customize/forms/flows/integrations/logic.mdx b/main/docs/customize/forms/flows/integrations/logic.mdx index 7ba4b1be9..703418421 100644 --- a/main/docs/customize/forms/flows/integrations/logic.mdx +++ b/main/docs/customize/forms/flows/integrations/logic.mdx @@ -37,7 +37,7 @@ Adds a conditional action with True / False branches to customize the behavior o -### Output response +### Output object @@ -66,9 +66,6 @@ Adds a conditional action with True / False branches to customize the behavior o - - - ## Store shared variable 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.
-### Output response +### Output object diff --git a/main/docs/customize/forms/flows/integrations/mailjet.mdx b/main/docs/customize/forms/flows/integrations/mailjet.mdx index bf27d4fef..e1a7a4a5c 100644 --- a/main/docs/customize/forms/flows/integrations/mailjet.mdx +++ b/main/docs/customize/forms/flows/integrations/mailjet.mdx @@ -83,6 +83,6 @@ Send an email using Mailjet as the email provider.
-### Output settings +### Output object You can find the expected response and status codes at [Mailjet's documentation](https://dev.mailjet.com/email/reference/send-emails/). \ No newline at end of file diff --git a/main/docs/customize/forms/flows/integrations/sendgrid.mdx b/main/docs/customize/forms/flows/integrations/sendgrid.mdx index 44b3fa0b8..3c789dbc6 100644 --- a/main/docs/customize/forms/flows/integrations/sendgrid.mdx +++ b/main/docs/customize/forms/flows/integrations/sendgrid.mdx @@ -71,6 +71,6 @@ Send an email using SendGrid as the email provider. -### Output settings +### Output object 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). \ No newline at end of file diff --git a/main/docs/customize/forms/flows/integrations/telegram.mdx b/main/docs/customize/forms/flows/integrations/telegram.mdx index 30ce375cf..86d24f65b 100644 --- a/main/docs/customize/forms/flows/integrations/telegram.mdx +++ b/main/docs/customize/forms/flows/integrations/telegram.mdx @@ -43,6 +43,6 @@ Send a messages to a Telegram chat -### Output settings +### Output object You can find the expected response and status codes at [Telegram's documentation](https://core.telegram.org/method/messages.sendMessage). \ No newline at end of file diff --git a/main/docs/customize/forms/flows/integrations/twilio.mdx b/main/docs/customize/forms/flows/integrations/twilio.mdx index b6706410b..141599737 100644 --- a/main/docs/customize/forms/flows/integrations/twilio.mdx +++ b/main/docs/customize/forms/flows/integrations/twilio.mdx @@ -49,7 +49,7 @@ Sends an SMS. -### Output settings +### Output object You can find all the expected status codes at [Twilio's documentation](https://www.twilio.com/docs/messaging/api/message-resource#message-status-values). @@ -88,6 +88,6 @@ TwiML payload (required) -### Output settings +### Output object You can find all the expected status codes at [Twilio's documentation](https://www.twilio.com/docs/voice/twiml). \ No newline at end of file diff --git a/main/docs/customize/forms/flows/integrations/whatsapp.mdx b/main/docs/customize/forms/flows/integrations/whatsapp.mdx index 9fa9b485c..fa8de2c35 100644 --- a/main/docs/customize/forms/flows/integrations/whatsapp.mdx +++ b/main/docs/customize/forms/flows/integrations/whatsapp.mdx @@ -70,6 +70,6 @@ The content of the message object will differ based on the selected message type -### Output settings +### Output object You can find all expected status codes at [Facebook's documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes). \ No newline at end of file diff --git a/main/docs/images/forms/flows/integrations/auth0-notifications-send-email.png b/main/docs/images/forms/flows/integrations/auth0-notifications-send-email.png new file mode 100644 index 000000000..bd0344739 Binary files /dev/null and b/main/docs/images/forms/flows/integrations/auth0-notifications-send-email.png differ