Skip to main content

Secrets User Story

This user guide provides a step-by-step walkthrough on creating a Secret and integrating it into a Playbook, illustrated with a practical example of triggering an email action.

Step 1: Create a Secret​

Navigate to the Settings section and choose "Secrets" to view previously created Secrets by your teammates. To create a new Secret, click on "ADD SECRET," opening a pane where you'll configure the necessary fields:

  1. Name: Assign a name to your Secret.

  2. Description: Provide a description for additional context.

  3. Expiration date: Optionally, set an expiration date for enhanced security.

  4. Choose a Secret type: Select a Secret type based on your specific use case.

For the purpose of this guide, we will choose Basic Authentication.

Step 2: Create a Form​

Access the Forms App in the Raven portal and click the "NEW FORM" button.

In the New Form pane:

  1. Add Title: Give a name to your Secret.

  2. Add Description: Include a description for context.

  3. Add component: Choose the desired component.

For this user guide, let's select the Textbox component.

Save the Form once all the necessary information is added.

Step 3: Create and configure Playbook​

Navigate to the Playbook App in the Raven portal and select "NEW PLAYBOOK." Begin by providing a name and description for the Playbook and save it.

Now, proceed to add the required Bricks, starting with the Form Brick.

  • Select the previously created Form and save the Brick.

The next Brick to be added is the send email Brick:

  • Add label: Provide a name for the Brick.

  • Credentials: Select the previously created Secret.

  • From: Specify the sender's information.

  • To: Define the recipient of the email.

  • Subject: Set the subject of the email.

  • Body: Specify the content of the email.

With all the necessary bricks in place, you can establish a connection by dragging the outlet of the Form to the inlet of the Send Email brick.

Save the Playbook, and you're ready to try it! This guide has equipped you with the knowledge to create a Secret and implement it.

Depending on your specific use case, you may choose a different type of Secret.

For more in-depth information on Secrets, refer to the official Secrets Documentation:

Secrets Documentation