trade. An action is live as soon as it is placed. You can rename it, change who may send it, and turn it off and on at any time. Actions are placed per environment: a Development action and a Production action are separate, even when they share a key.
In the Console
In the BotShield Console, select Verified Accounts in the sidebar, open the BotShield Actions tab and select Place an action. The list shows the actions placed in the environment selected in the header, with their state, where they live and when they were placed. All, Live and Off filter the list.
Select Place action. In Production, placing an action is confirmed with your Developer passkey.
Edit on a row changes the action’s name, the reason your customer reads, and who can send it. In the Console, in Production, a change that widens the action is confirmed with your Developer passkey (through the Gates API, the key’s Gates API access stands in for it): a new name or reason, turning on Staff can send, or turning off High-value. Tightening it, for example turning Staff can send off, asks for no passkey. To stop an action, select Turn off on its row. Turning off takes effect at once and never asks for a passkey. Turn on in Production is confirmed with your Developer passkey. Only organization admins place, change and turn actions on or off.
The name and the reason
Your customer reads one line for the action: its reason when you set one, otherwise its name. The reason is set in the Console’s Edit dialog, under The reason your customer reads: up to 90 characters, with no links. Clear it and your customer reads the name again. A request can replace that line for one ask:act_label on a tap on your page or on an ask through an agent.
With the Gates API
Use an API key with Gates API access. See Gates API. The environment comes from the key.curl
An act key is unique within one environment. The reason your customer reads is set in the Console only; the API returns it as
reason.
Turning an action off takes effect at once and is safe to repeat:
curl
curl
The action object
Staff can send
An action marked Staff can send (staffCanSend: true) is one your support team may send to a customer from the Console. Its reason, or its name when no reason is set, is what the customer reads, so write it as a plain statement about them, for example “You asked us to change your account details.”
While they are not placed, the BotShield Actions tab offers Add the three starter reasons: three staff-sendable actions for account details, a support call and account recovery, which you can rename or turn off like any other.
A high-value action is never sent by staff, whatever this setting says.
High-value actions
Mark an action high-value (highValue: true) when it should start only while your customer is signed in with you: a payout, a change of the account’s email, closing the account. A high-value action is asked for only by your server naming the customer by your own reference:
The refusal depends only on the action, so it comes back before anything about the number is looked up.
Error codes
Errors arrive asdata.error with HTTP 200. The Gates API action operations also return invalid_key, gates_scope_required, org_not_found and internal as described in Gates API.
An
actKey that breaks the pattern, a name longer than 60 characters or a whereUrl that is not https:// fails input validation with HTTP 400 before the operation runs.
Next steps
BotShield Actions
The act string, binding the terms, and a tap on your page.
Ask through an agent
Put an action in front of a BotShield Verified customer from your server.
Ask by phone number
Reach a customer by the number they gave you.
Gates API
Authentication and the shared error codes.
