Import Subscription (Subscribe to an Event)

curl --request POST \
  --url https://{projectID}.texterchat.com/server/api/v2/scenarios/manage/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "version": "v1",
    "name": "(SUB) All Messages",
    "description": "Sends a webhook for each new message (incoming & outgoing)",
    "triggerEvents": [
      "domain.message.created"
    ],
    "loaders": {
      "beforeConditions": [
        {
          "name": "chat",
          "alias": "chat",
          "params": {
            "id": {
              "##provide": {
                "provider": "message",
                "key": "parent_chat"
              }
            }
          },
          "confidentialData": false
        }
      ]
    },
    "conditions": [],
    "actions": [
      {
        "name": "request",
        "params": {
          "url": "{{yourWebhookURL}}",
          "method": "post",
          "json": true,
          "data": {
            "eventName": "newMessage",
            "eventData": {
              "message": {
                "##provide": {
                  "provider": "message",
                  "key": "message"
                }
              },
              "chat": {
                "##provide": {
                  "provider": "chat",
                  "key": "chat"
                }
              }
            }
          }
        },
        "confidentialData": false
      }
    ],
    "options": {
      "unorderedActions": false
    }
  },
  "asStatus": "active"
}
'

{
  "_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>"
        }
      ]
    }
  }
}

{
  "error": "authorUid: User with ID abc123 not found"
}

POST

scenarios

manage

import

curl --request POST \
  --url https://{projectID}.texterchat.com/server/api/v2/scenarios/manage/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "version": "v1",
    "name": "(SUB) All Messages",
    "description": "Sends a webhook for each new message (incoming & outgoing)",
    "triggerEvents": [
      "domain.message.created"
    ],
    "loaders": {
      "beforeConditions": [
        {
          "name": "chat",
          "alias": "chat",
          "params": {
            "id": {
              "##provide": {
                "provider": "message",
                "key": "parent_chat"
              }
            }
          },
          "confidentialData": false
        }
      ]
    },
    "conditions": [],
    "actions": [
      {
        "name": "request",
        "params": {
          "url": "{{yourWebhookURL}}",
          "method": "post",
          "json": true,
          "data": {
            "eventName": "newMessage",
            "eventData": {
              "message": {
                "##provide": {
                  "provider": "message",
                  "key": "message"
                }
              },
              "chat": {
                "##provide": {
                  "provider": "chat",
                  "key": "chat"
                }
              }
            }
          }
        },
        "confidentialData": false
      }
    ],
    "options": {
      "unorderedActions": false
    }
  },
  "asStatus": "active"
}
'

{
  "_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>"
        }
      ]
    }
  }
}

{
  "error": "authorUid: User with ID abc123 not found"
}

Required token scopes: Create scenarios, Manage scenarios on behalf of user (both are required)

url (required) - located under data.actions[0].params.url. Replace {{yourWebhookURL}} with the destination URL that should receive the events.
asStatus - keep "active" to enable the subscription immediately, "inactive" to save it as an inactive revision, or "draft" to save it as a draft.
Template-specific placeholders such as {{word1}}/{{word2}} (Messages with Specific Text) or {{targetLabelId}} (Specific Label Added).

Optionally, you can include an authorUid body field (a Texter user UID) to attribute the action to a specific user; when omitted, it is attributed automatically. Every event also has its own page under Webhooks in the sidebar (e.g. All Messages) with the ready-to-send template, exactly what to change in it, and the payload your URL receives. If the provided templates don’t satisfy your needs, contact Texter Support and we’ll gladly help modify any triggers, conditions, or actions for your webhook.

Authorizations

Authorization

string

header

required

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.

Body

application/json

data

object

required

The scenario definition (use one of the provided templates)

Show child attributes

asStatus

enum<string>

required

Available options:

active,

inactive,

draft

authorUid

string

Optional - Texter user ID (UID) to attribute the subscription to. When omitted, it is attributed automatically

Response

The created subscription (scenario object). 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

Show child attributes

activeRevision

object

The currently active version of the scenario

Show child attributes

Getting Started

Endpoints

Webhooks

Objects

Import Subscription (Subscribe to an Event)

Authorizations

Body

Response