Skip to content

Update trigger endpoint for UUID/key#511

Open
vrmiguel wants to merge 3 commits intomainfrom
tembo/trigger-endpoint-workflowid-key-auth-update
Open

Update trigger endpoint for UUID/key#511
vrmiguel wants to merge 3 commits intomainfrom
tembo/trigger-endpoint-workflowid-key-auth-update

Conversation

@vrmiguel
Copy link
Copy Markdown
Collaborator

@vrmiguel vrmiguel commented Mar 27, 2026

Summary

Updated the automation trigger endpoint to accept either workflow UUID or slug (key). Changes include:

Backend (monorepo):

  • Modified /automation/:keyOrId/trigger route to accept both UUID and slug
  • Added UUID regex validation to determine lookup method
  • Updated database queries to search by ID (UUID) or key_organizationId pair

Documentation (docs):

  • Updated examples to use ${AUTOMATION_ID} (UUID) instead of slug
  • Added documentation for both authentication methods:
    • Authorization: Bearer header
    • apiKey query parameter
  • Updated OpenAPI spec with new parameter name, descriptions, and dual auth examples
  • Clarified that automations can be identified by UUID or slug

Related Pull Requests


Want tembo to make any changes? Add a review or comment with @tembo and i'll get back to work!

View on Tembo View Agent Settings View on slack

…pdate docs

Co-authored-by: Vinícius <36349314+vrmiguel@users.noreply.github.com>
@tembo tembo bot added the tembo Pull request created by Tembo label Mar 27, 2026
@tembo
Copy link
Copy Markdown
Contributor

tembo bot commented Mar 27, 2026

Requesting review from @DarrenBaldwin07 who has experience with the following files modified in this PR:

  • openapi.documented.yml
  • features/automations.mdx

@tembo tembo bot requested a review from DarrenBaldwin07 March 27, 2026 15:35
Copy link
Copy Markdown
Collaborator Author

@vrmiguel vrmiguel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


1. Set a **Slug** on your automation (in the automation's properties panel).
2. Trigger the automation with that slug from API calls or slash commands.
2. Trigger the automation with that slug or its UUID from API calls or slash commands.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop step 1, make the page only mention the UUIDs

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the diff, it appears no changes were made to address this feedback yet.

I'll need to remove step 1 (the slug setup instruction) and update the content to only reference UUIDs for triggering automations.


The API key can be supplied either through the `Authorization: Bearer` header or the `apiKey` query parameter:

```bash
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drop these, only refer to the API docs

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diff appears to be empty, so it looks like no changes were made yet to address this. I'll remove the API key supply details and defer to the API docs instead.

…plify auth examples

Co-authored-by: Vinícius <36349314+vrmiguel@users.noreply.github.com>
@mintlify
Copy link
Copy Markdown

mintlify bot commented Mar 27, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tembo 🔴 Failed Mar 27, 2026, 4:53 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant