Skip to content
  • Auto
  • Light
  • Dark
Get Started

Execute

Execute Automation
client.automations.execute(stringid, AutomationExecuteParamsbody?, RequestOptionsoptions?): executionIdstringAutomationExecuteResponse
post/api/v1/automations/{id}/execute

Invokes the c1.api.automations.v1.AutomationService.ExecuteAutomation method.

Parameters
idstring

The id field.

Hide ParametersShow Parameters
contextcontextRecord<string, unknown>AutomationContext
optional

The AutomationContext message.

Returns
AutomationExecuteResponse

The ExecuteAutomationResponse message.

Hide ParametersShow Parameters
executionIdstring
optional

The executionId field.

formatint64
Request example TypeScript
import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.automations.execute('id');

console.log(response.executionId);
200 Example
{
  "executionId": "executionId"
}