Run an automation now - ClarusWMS

Run an automation now

curl --request POST \
  --url https://clarus-api.com/api/automations/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'

import requests

url = "https://clarus-api.com/api/automations/{id}/run"

headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'X-Clarus-Subdomain': '<api-key>'}
};

fetch('https://clarus-api.com/api/automations/{id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "<string>"
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

POST

/

api

/

automations

/

{id}

/

run

Run an automation now

curl --request POST \
  --url https://clarus-api.com/api/automations/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'

import requests

url = "https://clarus-api.com/api/automations/{id}/run"

headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'X-Clarus-Subdomain': '<api-key>'}
};

fetch('https://clarus-api.com/api/automations/{id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "<string>"
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

Behavior

Triggers the automation immediately. Primarily used for schedule-based automations (daily_schedule, weekly_schedule, monthly_schedule, one_time_schedule).

No request body required
The automation’s conditions are still evaluated before its actions run

Authorizations

Authorization

string

header

required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

FlowAuthorization Code

Authorization URL: https://clarus-api.com/oauth/authorize
Token URL: https://clarus-api.com/oauth/token

FlowClient Credentials

Token URL: https://clarus-api.com/oauth/token

X-Clarus-Subdomain

string

header

required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

id

integer

required

The unique identifier of the automation to run

Response

Automation triggered successfully