Create automation

Create an agent automation. Provide agentId; Outlit maps it to the hosted-agent processor internally.

POST /api/automations

Create automation

cURL

curl --request POST \
  --url https://app.outlit.ai/api/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "10000000-0000-4000-8000-000000000004",
  "name": "Churn response",
  "description": null,
  "enabled": false,
  "triggerType": "SIGNAL_OCCURRENCE",
  "signalIds": [
    "10000000-0000-4000-8000-000000000002"
  ],
  "destinationIds": []
}
'

200

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "automation": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "name": "<string>",
        "description": "<string>",
        "enabled": true,
        "triggerJson": "<unknown>",
        "audienceFilterJson": "<unknown>",
        "schemaVersion": "<string>",
        "configHash": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z",
        "lastRunAt": "2023-11-07T05:31:56Z",
        "nextRunAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "signals": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "<string>",
            "name": "<string>",
            "description": "<string>",
            "definition": "<unknown>",
            "schemaVersion": "<string>",
            "configHash": "<string>",
            "archivedAt": "2023-11-07T05:31:56Z",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "destinations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "<string>",
            "name": "<string>",
            "description": "<string>",
            "enabled": true,
            "maskedConfig": {},
            "lastSyncedAt": "2023-11-07T05:31:56Z",
            "providerErrorCode": "<string>",
            "providerErrorMessage": "<string>",
            "isDefault": true,
            "schemaVersion": "<string>",
            "configHash": "<string>",
            "archivedAt": "2023-11-07T05:31:56Z",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "activeSignalCount": 1,
        "activeDestinationCount": 1,
        "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Body

application/json

agentId · string<uuid> · required

name · string · required

Required string length: 1 - 120

triggerType · enum<string> · required

Available options: SIGNAL_OCCURRENCE, SCHEDULE

description · string | null

Maximum string length: 1000

enabled · boolean · default: true

signalIds · string<uuid>[]

Maximum array length: 50

matchMode · enum<string>

Available options: ANY, ALL, AT_LEAST

triggerWindow · object

Show child attributes

triggerThresholdCount · integer

Required range: 2 <= x <= 5

schedule · object

Show child attributes

audienceFilter · object

Show child attributes

processorPolicy · object

Show child attributes

deliveryPolicy · object

Show child attributes

destinationIds · string<uuid>[]

Maximum array length: 25

Response

200

application/json

Automation was created.

ok · boolean · required

commandId · string · required

Allowed value: "automation.create"

commandVersion · integer · required

correlationId · string · required

result · object · required

Show child attributes