External Bot Enabled

Subscribe to receive a notification when externalBot is set to true on a chat. Commonly used to hand a conversation over to your own bot: when this fires, your system starts answering the chat (Texter’s bot stands down) until External Bot is disabled. Toggle the flag via Update Chat Properties. Event name: externalBotEnabled\ Required token scopes:

Create scenarios
Manage scenarios on behalf of user

see Authentication Send the body below to Import Subscription. You only need to change:

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, or "inactive" to save it as an inactive revision.

Import body

{
  "data": {
    "version": "v1",
    "name": "(SUB) External Bot Enabled",
    "description": "Sends a webhook when externalBot is set to true on a chat.",
    "triggerEvents": [
      "domain.chat.updated.externalBot",
      "app.bot.chat.setExternal"
    ],
    "loaders": {},
    "conditions": [
      [
        {
          "name": "filtrex",
          "params": {
            "expression": "exists(externalBot) and externalBot",
            "value": {
              "##provide": {
                "provider": "chat",
                "key": "chat"
              }
            }
          },
          "confidentialData": false
        }
      ]
    ],
    "actions": [
      {
        "name": "request",
        "params": {
          "url": "{{yourWebhookURL}}",
          "method": "post",
          "json": true,
          "data": {
            "eventName": "externalBotEnabled",
            "eventData": {
              "chat": {
                "##provide": {
                  "provider": "chat",
                  "key": "chat"
                }
              }
            }
          }
        },
        "confidentialData": false
      }
    ],
    "options": {
      "unorderedActions": false
    }
  },
  "asStatus": "active"
}

A 201 response returns your new subscription - save its _id to manage it later. You can also add an optional authorUid root field (a Texter user UID) to attribute the subscription to a specific user.

Payload

When the event fires, your URL receives an HTTP POST with eventName: "externalBotEnabled" and the following eventData:

chat

Chat

The chat for which externalBot was just enabled. See the Chat object for all fields.

Example payload

{
  "eventName": "externalBotEnabled",
  "eventData": {
    "chat": {
      "_id": "69062b15262e17ab3033f886",
      "displayName": "Tyler Joseph",
      "externalBot": true,
      "...": "..."
    }
  }
}

Manage this subscription

Action	Endpoint
List subscriptions	List All Subscriptions
Pause	Inactivate Subscription
Resume	Activate Subscription
Delete	Delete Subscription
Debug executions	List Scenario Runs

​Subscribe

​Payload

​Manage this subscription

Subscribe

Payload

Manage this subscription