From bb064b62efec7f71530e03938399480baa968662 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 11 Sep 2025 09:14:24 +0000 Subject: [PATCH 1/2] Documentation edits made through Mintlify web editor --- .../mutations/agent/trigger-agent.mdx | 64 +++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 integrations/graphql-api/mutations/agent/trigger-agent.mdx diff --git a/integrations/graphql-api/mutations/agent/trigger-agent.mdx b/integrations/graphql-api/mutations/agent/trigger-agent.mdx new file mode 100644 index 0000000..98bc85c --- /dev/null +++ b/integrations/graphql-api/mutations/agent/trigger-agent.mdx @@ -0,0 +1,64 @@ +--- +title: "Trigger Agent" +--- + +The `triggerSchedule` mutation allows you to manually trigger an existing agent schedule to run immediately. + +Go to [agent docs](/advanced-features/agents/agents) to learn more about agents and how to create one. + +## Trigger Agent Schedules + +### Signature + +```graphql +triggerSchedule(id: String!): Boolean! +``` + +## Arguments + + + The unique identifier of the agent schedule to trigger. You can find it in URL of agent edit page. + + +## Response + +Returns a `Boolean` indicating whether the trigger was successful. + +## Usage Example + +Trigger an existing agent schedule: + +```graphql +mutation TriggerAgent($scheduleId: String!) { + success: triggerSchedule(id: $scheduleId) +} +``` + + + +```bash Request +curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer your_api_key" \ + -d '{ + "query": "mutation TriggerAgent($scheduleId: String!) { success: triggerSchedule(id: $scheduleId) }", + "variables": { + "scheduleId": "schedule_987654321" + } + }' \ + https://{ACCOUNT}.askwisdom.ai/graphql +``` + + + + + +```json Response +{ + "data": { + "triggerSchedule": true + } +} +``` + + \ No newline at end of file From 89a0861dd0a75a09fa2b300ff0aa66d98a44effc Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 11 Sep 2025 09:17:21 +0000 Subject: [PATCH 2/2] Documentation edits made through Mintlify web editor --- .../graphql-api/mutations/agent/trigger-agent.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/integrations/graphql-api/mutations/agent/trigger-agent.mdx b/integrations/graphql-api/mutations/agent/trigger-agent.mdx index 98bc85c..e840ae0 100644 --- a/integrations/graphql-api/mutations/agent/trigger-agent.mdx +++ b/integrations/graphql-api/mutations/agent/trigger-agent.mdx @@ -2,11 +2,11 @@ title: "Trigger Agent" --- -The `triggerSchedule` mutation allows you to manually trigger an existing agent schedule to run immediately. +The `triggerSchedule` mutation allows you to manually trigger an existing agent to run immediately. -Go to [agent docs](/advanced-features/agents/agents) to learn more about agents and how to create one. +Refer [agent docs](/advanced-features/agents/agents) to learn more about agents. -## Trigger Agent Schedules +## Trigger Agent ### Signature @@ -14,6 +14,10 @@ Go to [agent docs](/advanced-features/agents/agents) to learn more about agents triggerSchedule(id: String!): Boolean! ``` + + This mutation can only be executed if you have view access for the agent. + + ## Arguments