Trigger API

Map triggers to users or roles for an attended Bot Runner user by using the Trigger API. With the Trigger API, you can also create and delete event triggers.
All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header file example: -H X-Authorization <authentication token> or Authorization:Bearer <bearer token>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

Triggers

Up

delete /triggers/triggermapping/{id}

Deletes existing event trigger (triggersTriggermappingIdDelete)

Delete an event trigger that is associated with a user, role, or bot.

Path parameters

id (required)

Path Parameter — Event trigger identifier that you want to delete

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

The event trigger is deleted.

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Up

post /triggers/triggermapping

Creates event trigger (triggersTriggermappingPost)

Create an event trigger for a Bot Runner user, role, or bot file. Ensure that the associated users and roles have a Bot Runner license. Provide either users or roles. Do not provide both.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body TriggerMappingRequest (required)

Body Parameter —

Return type

TriggerMappingResponse

Example data

Content-Type: application/json

{
  "triggerMappings" : [ {
    "modifierBy" : 187.0,
    "roleId" : 721.0,
    "botName" : "botWithAllModifiers&CharacterKey8TriggerEvent--1663186087103",
    "botLabel" : "PRODUCTION",
    "botPath" : "Automation Anywhere\\Bots\\botA",
    "id" : 31.0,
    "lastModified" : "2022-11-28T20:21:39.586090Z",
    "botId" : 427.0,
    "userId" : 985.0
  }, {
    "modifierBy" : 187.0,
    "roleId" : 721.0,
    "botName" : "botWithAllModifiers&CharacterKey8TriggerEvent--1663186087103",
    "botLabel" : "PRODUCTION",
    "botPath" : "Automation Anywhere\\Bots\\botA",
    "id" : 31.0,
    "lastModified" : "2022-11-28T20:21:39.586090Z",
    "botId" : 427.0,
    "userId" : 985.0
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

The event trigger is created. TriggerMappingResponse

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Models

Methods

Table of Contents

Error
Role
Roles
TriggerMapping
TriggerMappingRequest
TriggerMappingResponse
User
Users

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

details (optional)

String More details of the error message

`Role` Up

Enter the IDs of the role. Only the roles listed here will be associated with the trigger.<strong>Note</strong> - The users associated with these roleIds must have a Bot Runner license to run the API.

`Roles` Up

roleIds (optional)

array[Role]

example: [721, 645]

`TriggerMapping` Up

trigger mapping object

id (optional)

BigDecimal ID of the trigger mapping

example: 31.0

userId (optional)

BigDecimal ID of the user

example: 985.0

roleId (optional)

BigDecimal ID of the role

example: 721.0

botPath (optional)

String The path of the bot

example: Automation Anywhere\Bots\botA

modifierBy (optional)

BigDecimal The ID of the user that did the triggerMapping

example: 187.0

lastModified (optional)

String The timestamp of the triggerMapping

example: 2022-11-28T20:21:39.586090Z

botName (optional)

String The name of the bot that got the triggerMapping.

example: botWithAllModifiers&CharacterKey8TriggerEvent--1663186087103

botId (optional)

BigDecimal The Id of the bot that got the triggerMapping

example: 427.0

botLabel (optional)

String The label of the bot that got the triggerMapping

example: PRODUCTION

`TriggerMappingRequest` Up

botFileId (optional)

BigDecimal Unique identifier of the bot file.

example: 106587.0

botFileLabel (optional)

String Bot file label. It can be PRODUCTION or empty for the latest version.<strong>NOTE</strong>-The user associated with these userIds must have a Bot Runner license to run the API.

example: PRODUCTION

users (optional)

Users

roles (optional)

Roles

`TriggerMappingResponse` Up

Trigger mapping response

triggerMappings (optional)

array[TriggerMapping] List of trigger mapping object. The triggerMappings array returns with all the details of the triggerMapping created. Each array element contains the following values.

`User` Up

Enter the IDs of the user. Only the users listed here will be associated with the trigger.

`Users` Up

userIds (optional)

array[User]

example: [985, 212]

Automation 360

Auslöser-API