דלג לתוכן הראשי
POST
/
scenarios
/
manage
Create Empty Scenario
curl --request POST \
  --url https://{projectID}.texterchat.com/server/api/v2/scenarios/manage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My custom automation",
  "description": "Notify our ERP when a chat is resolved",
  "triggerEvent": "domain.chat.resolved"
}
'
{
  "_id": "<string>",
  "system": "<string>",
  "drafts": [
    {}
  ],
  "inactiveRevisions": [
    {
      "_id": "<string>",
      "scenarioId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "version": 123,
      "parentVersion": 123,
      "revisionComment": "<string>",
      "triggerEvents": [
        "<string>"
      ],
      "conditions": [
        [
          {
            "name": "<string>",
            "params": "<unknown>",
            "confidentialData": true
          }
        ]
      ],
      "loaders": {
        "beforeConditions": [
          {
            "name": "<string>",
            "alias": "<string>",
            "params": "<unknown>",
            "confidentialData": true
          }
        ],
        "afterConditions": [
          {
            "name": "<string>",
            "alias": "<string>",
            "params": "<unknown>",
            "confidentialData": true
          }
        ]
      },
      "actions": [
        {
          "name": "<string>",
          "params": "<unknown>",
          "confidentialData": true
        }
      ],
      "loops": [
        {
          "loop": {}
        }
      ],
      "tags": [
        "<string>"
      ],
      "attachedData": {},
      "system": "<string>",
      "options": {
        "unorderedActions": true
      },
      "metadata": {
        "authorUid": "<string>",
        "created": 123,
        "modified": 123,
        "activated": 123,
        "activations": [
          {
            "timestamp": 123,
            "userUid": "<string>"
          }
        ]
      }
    }
  ],
  "activeRevision": {
    "_id": "<string>",
    "scenarioId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "version": 123,
    "parentVersion": 123,
    "revisionComment": "<string>",
    "triggerEvents": [
      "<string>"
    ],
    "conditions": [
      [
        {
          "name": "<string>",
          "params": "<unknown>",
          "confidentialData": true
        }
      ]
    ],
    "loaders": {
      "beforeConditions": [
        {
          "name": "<string>",
          "alias": "<string>",
          "params": "<unknown>",
          "confidentialData": true
        }
      ],
      "afterConditions": [
        {
          "name": "<string>",
          "alias": "<string>",
          "params": "<unknown>",
          "confidentialData": true
        }
      ]
    },
    "actions": [
      {
        "name": "<string>",
        "params": "<unknown>",
        "confidentialData": true
      }
    ],
    "loops": [
      {
        "loop": {}
      }
    ],
    "tags": [
      "<string>"
    ],
    "attachedData": {},
    "system": "<string>",
    "options": {
      "unorderedActions": true
    },
    "metadata": {
      "authorUid": "<string>",
      "created": 123,
      "modified": 123,
      "activated": 123,
      "activations": [
        {
          "timestamp": 123,
          "userUid": "<string>"
        }
      ]
    }
  }
}

הרשאות

​
Authorization
string
header
נדרש

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

גוף

application/json
​
name
string
נדרש

Scenario name

​
triggerEvent
string
נדרש

The event that triggers this scenario (e.g. domain.message.created). See List Components - Events for available values

​
description
string
​
authorUid
string

Optional - Texter user ID (UID) to attribute the scenario to

תגובה

The created scenario (as a draft). Field-by-field reference: The Scenario object

An event subscription (scenario) in Texter

​
_id
string

Unique identifier of the subscription/scenario

​
system
string

System scenario identifier. Present only on built-in system scenarios (returned when includeSystem=true)

​
drafts
object[]

Draft revisions of this scenario being edited. Same shape as a revision, but with status: "draft", no version/revisionComment, and metadata limited to authorUid/created/modified

​
inactiveRevisions
object[]

Inactive revisions

​
activeRevision
object

The currently active version of the scenario