Create a trigger | CloudRaker documentation

curl -X POST https://api.cloudraker.com/triggers \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "when": {
    "kind": "string",
    "schedule": {
      "expression": "string",
      "kind": "string",
      "timezone": "string"
    }
  },
  "open": {
    "agentIds": [
      "string"
    ],
    "spaces": [
      {
        "spaceId": "string",
        "access": "read"
      }
    ],
    "instruction": "string",
    "threadPolicy": "new",
    "filesFrom": "payload"
  },
  "permissions": {
    "runAsUserId": "string"
  }
}'

{
  "data": {
    "name": "string",
    "when": {
      "kind": "string",
      "schedule": {
        "expression": "string",
        "kind": "string",
        "timezone": "string"
      }
    },
    "open": {
      "agentIds": [
        "string"
      ],
      "spaces": [
        {
          "spaceId": "string",
          "access": "read"
        }
      ],
      "instruction": "string",
      "threadPolicy": "new",
      "filesFrom": "payload",
      "title": "string"
    },
    "permissions": {
      "runAsUserId": "string"
    },
    "id": "string",
    "nextRunAt": "2024-01-15T09:30:00Z",
    "triggerRef": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "enabled": true,
    "lastRun": {
      "status": "opened",
      "at": "2024-01-15T09:30:00Z",
      "sessionId": "string",
      "message": "string"
    },
    "legacy": {
      "channelId": "string",
      "channelType": "email",
      "automationId": "string"
    }
  },
  "secret": "string"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired1-80 characters

whenobjectRequired

openobjectRequired

permissionsobjectRequired

enabledbooleanOptionalDefaults to true

Response

The trigger and its one-time secret.

dataobject

secretstring

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error