IT and Development

Betty Blocks

13min

The Betty Blocks modules enable you to monitor, create, update, retrieve and delete records in your Betty Blocks account.

Get Started with Betty Blocks

Prerequisites

  • A Betty Blocks account - create a Betty Blocks account at bettyblocks.com/.
  • Users must have API permissions enabled in their accounts to connect with Make.

Assign the permissions in the app for which you want to establish the action. Go to App > Open > () User Icon > Enable the API permission for the user.

61f267be44c78.gif
61f267be44c78.gif


The module dialog fields that are displayed in bold (in the Make Make, not in this documentation article) are mandatory!

Connect Betty Blocks to Make

To connect your Betty Blocks account to Make you need to obtain the API Token from your Betty Blocks account and insert it in the Create a connection dialog in the Make module.

  1. Log in to your Betty Blocks account.
  2. Click Applications > Search the application > Open.

    Document image
    
  3. Click Users. Enable the API of the user with which you want to establish the connection.

    Document image
    
  4. Copy the API Key to your clipboard.

    Document image
    

    Please Note: You must create an application to establish a connection in Make. Create the application at Application > Create an Application.

    Document image
    
  5. Go to Make and open the Betty Blocks module's Create a connection dialog.

    Document image
    
  6. In the Connection name field, enter a name for the connection.
  7. In the Username field, enter the email address of the user with which you want to establish the connection.
  8. In the API Token field, enter the token copied in step 4.
  9. In the App Name field, enter the name of the app for which you establish the connection, and click Continue.

The connection has been established.

Betty Blocks modules

Records

Search Records

Searches for records of a specified data model or lists them all.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

Data Model

Select or map the data model whose records you want to search.

Filter ID

Enter (map) the Filter IDs to search the records based on the specified filter. For example, created date.

View ID

Enter (map) the View ID to fetch the data from a grid based on the specified view.

Limit

Set the maximum number of records Make should return during one execution cycle.

Get a Record

Retrieves a single record of a specified data model by record's ID.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

Data Model

Select or map the data model whose record details you want to retrieve. For example, employee.

Record ID

Select or map the Record ID whose details you want to retrieve.

Create a Record

Creates a record of a specified data model.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

Data Model

Select or map the data model whose record you want to create. Based on the data model you have selected dynamic fields related to the data model auto-populate. Enter the details to create the record.

Please note: Some of the parameters may have more validity checks set up in your Betty Blocks app.You may check them at Data Models > Model Name > Properties.

Update a Record

Updates a record specified by ID.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

Data Model

Select or map the data model whose record details you want to update.

Record ID

Select or map the Record ID whose details you want to update. Based on the selected record, dynamic fields related to the record auto-populate. Enter the details to update the record.

Delete a Record

Removes a record specified by ID.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

Data Model

Select or map the data model whose record details you want to delete. For example, employee.

Record ID

Select or map the Record ID you want to delete.

Actions

Triggers an Action

Executes an action specified by ID.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

Data Model

Select or map the data model for which you trigger the action.

Record ID

Select or map the Record ID for whose actions you want to create the trigger.

Action ID

Enter (map) the Action ID which you want to execute. You can find the Action ID in the page URL address when you click Actions > Action Name.

Other

Make an API Call

Performs an arbitrary authorized API call.

Field

Description

Connection

Establish a connection to your Betty Blocks account.

URL

Enter a path relative to https://<app_name>.bettyblocks.com/api/models.

For example, /users/records

Method

Select the HTTP method you want to use: GET: to retrieve information for an entry. POST: to create a new entry. PUT: to update/replace an existing entry. PATCH: to make a partial entry update. DELETE: to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.



Example of Use - List Records

The following API call returns all the records from your Betty Blocks account:

URL:

/users/records

Method:

GET

Document image


Matches of the search can be found in the module's Output under Bundle > Body.

In our example, 4 records were returned:

Document image


For the list of available endpoints, refer to the Betty Blocks API Documentation.