Action Builder

Overview

Action Builder is an online tool for field organizing, with an original use-case designed for the Labor context. While it has essentially no built-in outreach capabilities, it does provide robust record and relationship storage, including the ability to create custom record types. For more information, see Action Builder developer docs

Note

Custom Fields/Tags

Action Builder custom fields are treated as tags in both the SQL Mirror, and the API. This means that, with a couple exceptions such as date, values must be created ahead of time to be applied to a record. Each tag has two layers of taxonomy above it as well, that appear slightly differently in the SQL Mirror and in the API. In the SQL Mirror, each tag has a tag_category, and each category has a tag_group. In the API, the equivalents are called tag_field and tag_section, respectively (closer to the naming in the UI). Tags can be applied on Connections as well as on Entities.

Quick Start

To instantiate a class, you can either pass in the API token as an argument or set the ACTION_BUILDER_API_TOKEN environmental variable. The subdomain at which you access the UI must also be provided. If all calls from this object will be to the same Campaign in Action Builder, an optional campaign argument may also be supplied. If not supplied when instantiating, campaign may be passed to individual methods, instead.

from parsons import ActionBuilder

# First approach: Use API credentials via environmental variables
bldr = ActionBuilder(subdomain='yourorgsubdomain')

# Second approach: Pass API credentials as arguments
bldr = ActionBuilder(api_token='MY_API_TOKEN', subdomain='yourorgsubdomain')

# Third approach: Include campaign argument
     bldr = ActionBuilder(
             api_token = 'MY_API_TOKEN',
             subdomain = 'yourorgsubdomain',
             campaign = 'your-desired-campaign-id'
     )

You can then call various endpoints:

API