Skip to content

Feat/vault connection http variants #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BcnCarlos merged 2 commits into from
Mar 3, 2026
Merged

Feat/vault connection http variants #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
204fc23
Adding English version Vaults and References from Flow Actions
daniloasis-auth0 Feb 12, 2026
3254956
Merge branch 'main' into feat/vault-connection-http-variants
daniloasis-auth0 Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion main/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1495,7 +1495,20 @@
"docs/customize/forms/routers",
"docs/customize/forms/custom-field-components",
"docs/customize/forms/render",
"docs/customize/forms/vault",
{
"group": "Vaults",
"pages": [
"docs/customize/forms/vaults",
"docs/customize/forms/vaults/auth0",
"docs/customize/forms/vaults/http",
"docs/customize/forms/vaults/jwt",
"docs/customize/forms/vaults/mailjet",
"docs/customize/forms/vaults/sendgrid",
"docs/customize/forms/vaults/telegram",
"docs/customize/forms/vaults/twilio",
"docs/customize/forms/vaults/whatsapp"
]
},
"docs/customize/forms/custom-messages-and-translation",
"docs/customize/forms/resource-template-forms",
"docs/customize/forms/configure-progressive-profile-form",
Expand Down Expand Up @@ -8019,6 +8032,10 @@
"source": "/docs/customize/forms/intro-to-forms",
"destination": "/docs/customize/forms/nodes-and-components"
},
{
"source": "/docs/customize/forms/vault",
"destination": "/docs/customize/forms/vaults"
},
{
"source": "/docs/videos/get-started-series/learn-logout",
"destination": "/docs/articles"
Expand Down
3 changes: 2 additions & 1 deletion main/docs/customize/forms/flows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: Describes how to use Flows with Forms.
title: Introduction to Flows
title: Flows
sidebarTitle: Overview
---
Flows allow you to visually build the server-side logic that can be executed within your Forms and handle the collected information, integrate any service with an API or trigger automations.

Expand Down
69 changes: 29 additions & 40 deletions main/docs/customize/forms/flows/integrations/auth0.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,11 @@
description: Learn how to configure your Auth0 pre-built flow actions to make requests against the Management API or send custom notifications.
title: Auth0
---
## Configure your Auth0 Vault Connection

## Management API
Learn how to configure a Vault Connection for your Auth0 Flow Actions at [Auth0 Vault Connection](/docs/customize/forms/vaults/auth0).

### 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, <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>**:

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

<Warning>

Remember to authorize your Machine-to-Machine application to access the Management API and select the right scopes (eg. `update:users_app_metadata`).

</Warning>

### Create user
## Create user

<Warning>
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).
Expand All @@ -27,7 +16,7 @@ Create a user.

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

#### Input settings
### Input settings

<table class="table">
<thead>
Expand All @@ -44,17 +33,17 @@ Create a user.
</tbody>
</table>

#### Output object
### Output object

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.

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

#### Input settings
### Input settings

<table class="table">
<thead>
Expand All @@ -71,17 +60,17 @@ Retrieve user details.
</tbody>
</table>

#### Output object
### Output object

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.

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

#### Input settings
### Input settings

<table class="table">
<thead>
Expand All @@ -102,17 +91,17 @@ Update a user.
</tbody>
</table>

#### Output object
### 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.

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

#### Input settings
### Input settings

<table class="table">
<thead>
Expand Down Expand Up @@ -163,13 +152,13 @@ Available HTTP methods include:
</tbody>
</table>

#### Output object
### Output object

Review [Auth0 Management API](https://auth0.com/docs/api/management/v2/introduction) for expected responses and status codes.

## Notifications

### Send email
## Send email

Send a custom email using your [configured email provider](docs/customize/email).

Expand All @@ -179,12 +168,12 @@ Send a custom email using your [configured email provider](docs/customize/email)

<Frame>![](/docs/images/forms/flows/integrations/auth0-notifications-send-email.png)</Frame>

#### Input settings
### Input settings

| Parameter | Description |
|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Use custom sender email | By default, we will use the sender email you have configured in your customized email provider settings. Enable this option if you want to use a different sender email or name. |
| Recipient email | The recipient’s email |
| Recipient email | The recipient’s email. |
| Custom variables | Add custom variables to be inserted in your email template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`. |
| Subject | The email subject. Supports custom variables and Liquid syntax. |
| Message | The email message is in HTML format, uses Liquid syntax, and supports custom variables. |
Expand All @@ -195,21 +184,21 @@ Subject and Message can use a combination of Liquid syntax with [common variable
Use custom variables to pass information between Forms / Flows context and Subject and Message content.
</Callout>

#### Output object
### 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
### Output object example

```json
{
"success": true
}
```

### Send SMS
## Send SMS

Send a custom SMS using your [configured phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).

Expand All @@ -219,12 +208,12 @@ Send a custom SMS using your [configured phone provider](https://auth0.com/docs/

<Frame>![](/docs/images/forms/flows/integrations/auth0-notifications-send-sms.png)</Frame>

#### Input settings
### Input settings

| Parameter | Description |
|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From | By default, we will use the sender phone number you have configured in your customized phone provider settings. Input a custom value if you want to use a different sender phone number. |
| To | The recipient’s phone number |
| To | The recipient’s phone number. |
| Custom variables | Add custom variables to be inserted in your phone template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`. |
| Message | The phone message uses Liquid syntax and supports custom variables. |

Expand All @@ -234,21 +223,21 @@ Message can use a combination of Liquid syntax with [common variables](https://a
Use custom variables to pass information between Forms / Flows context and Message content.
</Callout>

#### Output object
### Output object

| Property | Type | Description |
|-----------------|---------|----------------------------------------------------------------------------------------------------------------------|
| success | Boolean | Indicates if the phone message was successfully queued to be sent, regardless of whether the delivery failed or not. |

#### Output object example
### Output object example

```json
{
"success": true
}
```

### Make call
## Make call

Send a custom voice message using your [configured phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).

Expand All @@ -258,12 +247,12 @@ Send a custom voice message using your [configured phone provider](https://auth0

<Frame>![](/docs/images/forms/flows/integrations/auth0-notifications-make-call.png)</Frame>

#### Input settings
### Input settings

| Parameter | Description |
|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From | By default, we will use the sender phone number you have configured in your customized phone provider settings. Input a custom value if you want to use a different sender phone number. |
| To | The recipient’s phone number |
| To | The recipient’s phone number. |
| Custom variables | Add custom variables to be inserted in your phone template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`. |
| Message | The phone message uses Liquid syntax and supports custom variables. |

Expand All @@ -273,13 +262,13 @@ Message can use a combination of Liquid syntax with [common variables](https://a
Use custom variables to pass information between Forms / Flows context and Message content.
</Callout>

#### Output object
### Output object

| Property | Type | Description |
|-----------------|---------|----------------------------------------------------------------------------------------------------------------------|
| success | Boolean | Indicates if the phone message was successfully queued to be sent, regardless of whether the delivery failed or not. |

#### Output object example
### Output object example

```json
{
Expand Down
6 changes: 2 additions & 4 deletions main/docs/customize/forms/flows/integrations/http-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
description: Learn how to configure your HTTP Request flow actions to send custom requests to external APIs or services.
title: HTTP Request
---
## Configure your Vault connection
## Configure your HTTP Vault Connection

To configure a Vault connection for your HTTP Request actions, you will need a **Bearer token:**

<Frame>![Dashboard > Actions > Forms > Flows > Actions > HTTP Request ](/docs/images/cdy7uua7fh8z/3X0Qbe9o1bx8q9ctxYZTO2/468b4d9b81bad93ab38b0b01dc773788/http-vault-connection.png)</Frame>
Learn how to configure a Vault Connection for your HTTP Request Flow Actions at [HTTP Vault Connection](/docs/customize/forms/vaults/http).

## HTTP Request

Expand Down
6 changes: 2 additions & 4 deletions main/docs/customize/forms/flows/integrations/json-web-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ title: JSON Web Token
---
This list of <Tooltip tip="JSON Web Token (JWT): Standard ID Token format (and often Access Token format) used to represent claims securely between two parties." cta="View Glossary" href="/docs/glossary?term=JSON+Web+Token">JSON Web Token</Tooltip> actions allows you to generate, verify, and decode JWTs in your flows.

## Configure your Vault connection
## Configure your JWT Vault Connection

To configure a Vault connection for your JSON Web Token actions using **HS256 algorithm**, you will need a **Secret:**

<Frame>![Dashboard > Actions > Forms > Flows > actions > JSON web token](/docs/images/cdy7uua7fh8z/1WnUlIe2QZf39G45PHcQGp/40d768da226a0cefa09c62c5cab78577/jwt-vault-connection.png)</Frame>
Learn how to configure a Vault Connection for your JSON Web Token Flow Actions at [JWT Vault Connection](/docs/customize/forms/vaults/jwt).

## Sign JSON web token

Expand Down
12 changes: 4 additions & 8 deletions main/docs/customize/forms/flows/integrations/mailjet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
---
description: Learn how to configure your Mailjet flow actions to send emails.
title: Mailjet
description: Learn how to configure your MailJet flow actions to send emails.
title: MailJet
---
## Configure your Vault connection
## Configure your MailJet Vault Connection

To configure a Vault connection for your Mailjet actions, you will need an **API key** and a **Secret key**:

<Frame>![Dashboard > Actions > Forms > Flows > actions > MailJet](/docs/images/cdy7uua7fh8z/1ydxHXrM2idHnUOAjWAW4R/55cdb295e87894dd9f89bed8784e3a5d/mailjet-vault-connection.png)</Frame>

They can be found at [Mailjet dashboard's](https://app.mailjet.com/account/api_keys) Account page under the API keys.
Learn how to configure a Vault Connection for your MailJet Flow Actions at [MailJet Vault Connection](/docs/customize/forms/vaults/mailjet).

## Send email

Expand Down
8 changes: 2 additions & 6 deletions main/docs/customize/forms/flows/integrations/sendgrid.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
description: Learn how to configure your SendGrid flow actions to send emails.
title: SendGrid
---
## Configure your Vault connection
## Configure your SendGrid Vault Connection

To configure a Vault connection for your SendGrid actions, you will need an **API key:**

<Frame>![Dashboard > Actions > Forms > Flows > actions > SendGrid](/docs/images/cdy7uua7fh8z/7qruolnilHd2RUvA3dGKfV/a278873b5b0564364bfdd9e15ca1d5cf/sendgrid-vault-connection.png)</Frame>

It can be found at [SendGrid dashboard's](https://app.sendgrid.com/settings/api_keys) Settings page under the API keys.
Learn how to configure a Vault Connection for your SendGrid Flow Actions at [SendGrid Vault Connection](/docs/customize/forms/vaults/sendgrid).

## Send email

Expand Down
8 changes: 2 additions & 6 deletions main/docs/customize/forms/flows/integrations/telegram.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
description: Learn how to configure your Telegram flow actions to send messages.
title: Telegram
---
## Configure your Vault connection
## Configure your Telegram Vault Connection

To configure a Vault connection for your Telegram actions, you will need a **Token:**

<Frame>![Dashboard > Actions > Forms > Flows > actions > Telegram](/docs/images/cdy7uua7fh8z/21Q1BjBAgDHxVR0YgAqedA/fcd1c5dfbd5c6f6fe8d9ea4c951efcb3/whatsapp-vault-connection.png)</Frame>

To learn how to generate a token, read [Telegram's Bot API](https://core.telegram.org/#bot-api).
Learn how to configure a Vault Connection for your Telegram Flow Actions at [Telegram Vault Connection](/docs/customize/forms/vaults/telegram).

## Send Telegram message

Expand Down
8 changes: 2 additions & 6 deletions main/docs/customize/forms/flows/integrations/twilio.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@ title: Twilio
---
This list of Twilio actions allows you to send SMS and make calls using Twilio as provider.

## Configure your Vault connection
## Configure your Twilio Vault Connection

To configure a Vault connection for your Twilio actions, you will need an **Account SID** and an **Auth token**:

<Frame>![Dashboard > Actions > Forms > Flows > actions > Twilio](/docs/images/cdy7uua7fh8z/7MafHKBR1acJE0iGtab2J4/5f4d85a149b9dbd881b4c4558bb0e7bb/twilio-vault-connection.png)</Frame>

They can be found at [Twilio's console dashboard](https://console.twilio.com/).
Learn how to configure a Vault Connection for your Twilio Flow Actions at [Twilio Vault Connection](/docs/customize/forms/vaults/twilio).

## Send SMS

Expand Down
8 changes: 2 additions & 6 deletions main/docs/customize/forms/flows/integrations/whatsapp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
description: Learn how to configure your WhatsApp flow actions to send messages.
title: WhatsApp
---
## Configure your Vault connection
## Configure your WhatsApp Vault Connection

To configure a Vault connection for your WhatsApp actions, you will need a **Token**:

<Frame>![Dashboard > Actions > Forms > Flows > actions > WhatsApp](/docs/images/cdy7uua7fh8z/1Qevi3V1UbkUjb6c51x6R4/44590932bdced6e50afa436835c7cb15/whatsapp-vault-connection.png)</Frame>

To learn how to generate a token, read [using authorization tokens for WhatsApp](https://developers.facebook.com/blog/post/2022/12/05/auth-tokens/).
Learn how to configure a Vault Connection for your WhatsApp Flow Actions at [WhatsApp Vault Connection](/docs/customize/forms/vaults/whatsapp).

## Send message

Expand Down
Loading
Loading