Skip to content

Update trigger endpoint for UUID/key #511

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

Open
vrmiguel wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update trigger endpoint for UUID/key #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd13a46
feat(api,docs): support workflow ID or key for trigger endpoint and u…
tembo[bot] Mar 27, 2026
efcfba7
docs(features): update automations.mdx to reference UUID only and sim…
tembo[bot] Mar 27, 2026
2c05caa
Update automations.mdx
vrmiguel Mar 27, 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
11 changes: 2 additions & 9 deletions features/automations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,12 @@ React to events from your integrations in real-time.
| **Linear** | Issue created, issue updated, status changed |
| **Slack** | Message in channel, @tembo mention |

### Automation slug
#### Trigger through webhooks

Use an automation slug to trigger an automation on demand from external systems or chat commands.

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.
You can trigger an automation on demand from external systems using the automation's [webhook trigger endpoint](/api/trigger-automation).

The payload is passed to the automation as event context, so your instructions can reference it directly. For example, you could write instructions like _"Fix the issue at the URL provided in the event payload"_.

#### API trigger (webhook)

You can trigger an automation programmatically using its slug via our SDK or an [API request](/api/trigger-automation).

#### Slash command trigger

You can trigger a task with the selected automation by using slash commands.
Expand Down
36 changes: 27 additions & 9 deletions openapi.documented.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ paths:
const response = await client.task.search({ q: 'authentication bug' });

console.log(response.issues);
/automation/{slug}/trigger:
/automation/{keyOrId}/trigger:
post:
responses:
"200":
Expand Down Expand Up @@ -438,7 +438,7 @@ paths:
- createdAt
- updatedAt
"404":
description: Automation not found (no automation with the given key exists in your organization)
description: Automation not found (no automation with the given key or ID exists in your organization)
content:
application/json:
schema:
Expand All @@ -451,14 +451,23 @@ paths:
- error
operationId: postPublic-apiAutomationTrigger
parameters:
- name: slug
- name: keyOrId
in: path
description: The slug of the automation to trigger. Set in the automation's properties panel.
description: The automation's UUID or its slug (key). You can find the UUID in the automation's properties panel.
required: true
schema:
type: string
example: myAutomation
description: Trigger an automation with an arbitrary JSON payload, which is passed to the automation as event context. Only automations with a slug set can be triggered.
example: a1b2c3d4-5678-9abc-def0-1234567890ab
- name: apiKey
in: query
description: API key for authentication. Alternative to using the Authorization header.
required: false
schema:
type: string
description: |-
Trigger an automation with an arbitrary JSON payload, which is passed to the automation as event context.

You can identify the automation by either its UUID or its slug (key). The API key can be supplied via the `Authorization: Bearer` header or the `apiKey` query parameter.
summary: Trigger Automation
requestBody:
description: Arbitrary JSON payload passed to the automation as event context. Your automation instructions can reference any values in this payload.
Expand All @@ -473,11 +482,20 @@ paths:
required: false
x-codeSamples:
- lang: bash
label: Bearer Auth
source: |-
curl -s -X POST \
"https://api.tembo.io/automation/${AUTOMATION_ID}/trigger" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{"issue_url": "https://github.com/org/repo/issues/42"}' | jq .
- lang: bash
label: Query Param Auth
source: |-
curl -X POST https://api.tembo.io/automation/myAutomation/trigger \
-H "Authorization: Bearer YOUR_API_KEY" \
curl -s -X POST \
"https://api.tembo.io/automation/${AUTOMATION_ID}/trigger?apiKey=${API_KEY}" \
-H "Content-Type: application/json" \
-d '{"issue_url": "https://github.com/org/repo/issues/42"}'
-d '{"issue_url": "https://github.com/org/repo/issues/42"}' | jq .
/repository/list:
get:
responses:
Expand Down