Create Automation

Estimated reading: 6 minutes

The Create Automation page allows users to configure event-driven automations that perform predefined actions when specific events occur. Each automation consists of a Trigger, which defines when the automation runs, and an Action, which defines what happens when the trigger conditions are met.

Creating Automation

To create automation:

1. Click Create Automation.
2. Configure the Trigger by selecting the event source and event actions.
3. Add filters to specify the conditions that must be met for the automation to run.
4. Select an Action Type and configure its required settings.
5. Set the Active toggle to enable or disable the automation.
6. Save the automation.

Trigger

The Trigger section defines the events that initiate the automation.

Field Description
Event Source Select the source from which the event originates. The available options depend on the supported automation configuration.
Event Action Select one or more event actions that should trigger the automation.

Created: Triggers the automation when a new item is created.
Updated: Triggers the automation when an existing item is modified.
Deleted: Triggers the automation when an item is deleted.
Filters Restricts the automation to events that match specified conditions.

Where: Select the property to evaluate.

Operator: Select the comparison condition to apply. Available operators include:
• =: Checks whether the property matches the specified value.
• contains: Checks whether the property contains the specified value.
• does not contain: Checks whether the property does not contain the specified value.
• starts with: Checks whether the property begins with the specified value.
• ends with: Checks whether the property ends with the specified value.

Value: Enter the value to compare against the selected property.

Add Filter: Add another filter condition.
Note: The automation runs when an event matches the configured trigger criteria and filter conditions.

Action

The Action section defines what happens when the configured trigger conditions are met. Select an Action Type to determine how the automation responds to an event.

Action Types

Action Type Description
Webhook Sends an HTTP POST request to a specified HTTPS endpoint.
GitHub Dispatch Sends a repository dispatch event to a GitHub repository, allowing a GitHub Actions workflow to run.
Slack Sends notifications to a connected Slack workspace.

The configuration fields displayed depend on the selected action type.

Webhook

The Webhook action sends an HTTP POST request to a specified HTTPS endpoint whenever the automation is triggered. The request contains event-specific information and configured headers, allowing external systems to receive and process automation events.

Configuration

Field Description
Webhook URL Specifies the HTTPS endpoint that receives the webhook request. Only HTTPS URLs are supported.
API Version Specifies the version used to format the webhook payload.
Headers Defines the headers included in the webhook request. Control Plane automatically includes default headers and supports additional custom headers.
Webhook Secret A secret used to generate signatures for verifying the authenticity of webhook requests.

Default Headers

The following headers are automatically included in every webhook request:

Header Description
content-type Specifies the payload format. The default value is application/json.
user-agent Identifies the application sending the request.
x-langfuse-signature Contains signature information that allows the receiving system to verify the request.

Custom Headers

Custom headers can be added when the receiving endpoint requires additional information.

Field Description
Header Name Specifies the name of the HTTP header.
Value Specifies the value assigned to the header.
Add Custom Header Adds another custom header entry.

Webhook Secret

A webhook secret is automatically generated when the automation is created.

i. Used to generate request signatures.
ii. Signatures are included in the x-langfuse-signature header.
iii. Receiving systems can validate incoming webhook requests using the corresponding secret.
iv. The secret should be stored securely and kept confidential.

Result

When the automation is triggered, Control Plane sends an HTTP POST request to the configured endpoint, including the event payload and configured headers.

GitHub Dispatch

The GitHub Dispatch action sends a repository_dispatch event to a GitHub repository. This allows GitHub Actions workflows configured for the specified event type to run automatically when the automation is triggered.

Configuration

Field Description
Repository Dispatch URL Specifies the GitHub API endpoint that receives the repository dispatch request.
Event Type Specifies the custom event name sent to GitHub.
GitHub Personal Access Token Specifies the token used to authenticate and authorize the request.

Repository Dispatch URL

Enter the GitHub repository dispatch endpoint in the following format:

https://api.github.com/repos/<owner>/<repository>/dispatches

Replace the owner and repository values with the target repository details.

Event Type

Specify a custom event name that identifies the event being sent to GitHub.

For example: prompt-update

“The value must match the event type configured in the corresponding GitHub Actions workflow.

GitHub Personal Access Token

Provide a GitHub Personal Access Token (PAT) to authenticate the dispatch request.

Token Requirements

A Fine-Grained Personal Access Token is recommended.

Configure the token with:

i. Access to the target repository.
ii. Repository permission Contents: Read and write.
iii. An appropriate expiration period.
iv. Access limited to only the repositories required for the integration.

Creating a Fine-Grained Personal Access Token

1. Sign in to GitHub.
2. Navigate to Settings > Developer Settings > Personal Access Tokens > Fine-Grained Tokens.
3. Select Generate New Token.
4. Enter a token name and optional description.
5. Select the appropriate resource owner.
6. Grant access to the target repository.
7. Set Contents permission to Read and write.
8. Configure the token expiration period.
9. Generate the token and copy it securely into the GitHub Personal Access Token field.

Security Recommendations

a. Store tokens securely.
b. Do not expose tokens in source code or logs.
c. Grant only the minimum permissions required.
d. Periodically rotate and renew tokens.
e. Revoke unused tokens immediately.

Result

When the automation is triggered:

1. A repository dispatch request is sent to the specified GitHub repository.
2. GitHub validates the request using the provided token.
3. A repository_dispatch event is created in the repository.
4. GitHub Actions workflows configured for the specified event type can run.

Slack

The Slack action sends notifications to a connected Slack workspace whenever the automation is triggered. This allows teams to receive real-time updates and event notifications directly within Slack.

Configuration

Field Description
Slack Connection Connect and authorize a Slack workspace for sending automation notifications.
Connect Slack Opens the Slack authorization flow and associates a workspace with the automation.

Connect Slack

Before Slack notifications can be sent, a Slack workspace must be connected and authorized.

To configure a Slack connection:

1. Select Slack as the Action Type.
2. Click Connect Slack.
3. Complete the Slack authorization process.
4. Grant the permissions requested by the integration.
5. Save the automation configuration.

Notes

1. A valid Slack connection is required.
2. Workspace administrators may need to approve the integration depending on workspace policies.
3. Notifications are sent only when the automation is successfully triggered.

Result

When the automation is triggered, a notification is sent to the connected Slack workspace using the configured integration.

Save Automation

After configuring the trigger and action:

1. Review the automation settings.
2. Enable Active if the automation should run.
3. Click Save Automation to save the configuration.
4. Click Cancel to discard unsaved changes.

Automation Status

Status Description
Active The automation is enabled and can execute when its trigger conditions are met.
Inactive The automation is disabled and does not execute until it is re-enabled.
Share this Doc

Create Automation

Or copy link

CONTENTS
Robility Chatbot
Robility Assistant
Online