Creating a Bot User

FireHydrant allows you to access our JSON API with a bot user. A bot user is a separate entity in your organization that can perform actions just as other users can. Bot users can interact with the FireHydrant API using token based authentication; any action called by a bot user is authenticated with a token.

Creating the bot user

To create a bot user:

  1. In the left nav, click Organization > Bot users
  2. Click + Create bot user to set up a new bot user. The next page provides fields for a name and description of the bot; these fields are for your reference and do not impact how the API is used.
  3. Provide the name and description and click Save
    You are redirected to the bot users page, where your token is displayed.
    This token will only be displayed once.
  4. Copy the bot token and record it somewhere safe, as it grants access to the FireHydrant API on behalf of your organization.

Last updated on 3/28/2023