Skip to main content

GlassFrog API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a GlassFrog API location.
glassfrog_api.png

GlassFrog API

  1. Click the + icon on the Nexset that will be sent to the GlassFrog API destination, and select the Send to Destination option from the menu.

  2. Select the GlassFrog API connector from the list of available destination connectors. Then, select the credential that will be used to connect to the GlassFrog organization, and click Next; or, create a new GlassFrog API credential for use in this flow.

  3. In Nexla, GlassFrog API destinations can be created using pre-built endpoint templates, which expedite destination setup for common GlassFrog API endpoints. Each template is designed specifically for the corresponding GlassFrog API endpoint, making destination setup easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    GlassFrog API destinations can also be configured manually, allowing you to send data to GlassFrog API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common GlassFrog API endpoints. Each template is designed specifically for the corresponding GlassFrog API endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.

    Create Person

    Creates a new member in the GlassFrog organization with the provided name, email, and optional external ID.

    The email address must be unique within the organization. Newly created people can then be assigned to roles using the Assign Person to Role endpoint.

    Update Person

    Updates an existing GlassFrog organization member's name, email, or external ID.

    Only the fields included in the payload will be updated. Use the Get Person source endpoint to retrieve current values before making changes.

    Remove Person from Organization

    Removes a person from the GlassFrog organization, revoking their access and removing their role assignments.

    This action is irreversible and will remove all role assignments for the person. Use the Get Person source endpoint to confirm the correct ID before proceeding.

    Assign Person to Role

    Assigns a person to a role within a specific circle in GlassFrog, creating a new role assignment record.

    Use the List Circles and List Role Assignments source endpoints to retrieve valid circle, role, and person IDs.

    Remove Person from Role Assignment

    Removes a person from a specific role assignment by its ID.

    Use the List Role Assignments source endpoint to retrieve valid assignment IDs. This removes only the specified assignment, not the person or role.

    Create Circle

    Creates a new circle in the GlassFrog organization for structuring governance and role groupings.

    • Sends a POST request to https://api.glassfrog.com/api/v3/circles with the circle configuration payload.
    • Each record should include the circle name and optionally a parent circle ID and purpose statement.

    Use the List Circles source endpoint to retrieve valid parent circle IDs for nested circle creation.

    Update Circle

    Updates an existing GlassFrog circle's properties such as its name, purpose, or strategy.

    Only the fields included in the payload will be updated. Use the List Circles source endpoint to retrieve valid circle IDs.

    Delete Circle

    Deletes a GlassFrog circle by its unique identifier. This removes the circle and its associated roles from the organization structure.

    Deleting a circle will also remove any roles defined within it. This action is irreversible.

    Create Role

    Creates a new role within a GlassFrog circle, defining a new governance function with purpose, domains, and accountabilities.

    • Sends a POST request to https://api.glassfrog.com/api/v3/roles with the role definition payload.
    • Each record should include the role name, parent circle ID, and optionally purpose and accountability descriptions.

    Use the List Circles source endpoint to retrieve valid circle IDs for assigning the new role to the correct circle.

    Update Role

    Updates an existing GlassFrog role's name, purpose, accountabilities, or domains.

    Only the fields included in the payload will be updated. Use the Get Role source endpoint to retrieve the current role definition.

    Delete Role

    Deletes a role from a GlassFrog circle by its unique identifier.

    Deleting a role removes it from the circle along with all associated accountabilities and domains. Existing role assignments for this role will also be removed.

    Create Project

    Creates a new project within a GlassFrog circle or role, capturing a desired outcome and its current status.

    Use the List Circles source endpoint to retrieve valid circle IDs for the project owner.

    Update Project

    Updates an existing GlassFrog project's description, status, or other properties.

    Use the Get Project source endpoint to retrieve current project values before making updates.

    Delete Project

    Permanently deletes a GlassFrog project by its unique identifier.

    This action is irreversible. Use the Get Project source endpoint to confirm the correct project before deleting.

    Create Action

    Creates a new next-action or tension in GlassFrog, capturing a discrete task or governance tension from a tactical meeting.

    Actions represent discrete next steps. Tensions represent governance issues to be processed in a governance meeting.

    Create Metric

    Creates a new metric for a GlassFrog role or circle to be tracked in tactical meetings.

    Metrics are reported on during tactical meetings. Frequency options typically include weekly, monthly, or quarterly.

    Update Metric

    Updates an existing GlassFrog metric's description, owning role, or frequency.

    Use the Get Metric source endpoint to retrieve the current metric values before making updates.

    Delete Metric

    Permanently deletes a GlassFrog metric by its unique identifier.

    This action is irreversible. The metric will be permanently removed from the circle's tactical meeting agenda.

    Update Checklist Item

    Updates an existing GlassFrog checklist item's description or associated role.

    Use the Get Checklist Item source endpoint to retrieve the current values before making updates.

    Delete Checklist Item

    Permanently deletes a GlassFrog checklist item by its unique identifier.

    This action is irreversible. The checklist item will be permanently removed from the circle's tactical meeting agenda.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can send a test payload to verify the destination is configured correctly.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. A test payload will be sent and the result will be displayed in the Endpoint Test Result panel on the right.

  • If the test result is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again to verify the updated configuration.

Configure Manually​

GlassFrog API destinations can also be manually configured to send data to any valid GlassFrog API v3 endpoint. You can also configure Nexla to automatically send the response received from the GlassFrog API after each call to a new Nexla webhook data source.

First, select the API method that will be used for calls to the GlassFrog API from the Method pulldown menu. Common methods for GlassFrog API destinations include:

  • POST: For creating new resources (such as projects or actions) in GlassFrog.
  • PATCH: For partially updating existing resources.
  • DELETE: For removing resources from your GlassFrog organization.

Data Format​

  1. Select the format in which the Nexset data will be sent to the GlassFrog API from the Content Format pulldown menu. GlassFrog API v3 accepts and returns JSON, so select JSON as the content format. Nexla will automatically convert the data to JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the GlassFrog API v3 endpoint to which you want to send the Nexset data in the URL field. For update or delete operations, include the ID of the resource to be updated or removed at the end of the URL (for example, https://api.glassfrog.com/api/v3/projects/12345). For create operations, use the collection endpoint (for example, https://api.glassfrog.com/api/v3/projects).

For a complete reference of GlassFrog API v3 write endpoints and required request body structures, refer to the GlassFrog API documentation and the GlassFrog API v3 Postman reference.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. The GlassFrog API authentication header (X-Auth-Token) is handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this GlassFrog API destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the GlassFrog API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the GlassFrog API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the GlassFrog API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the GlassFrog API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured GlassFrog API endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the GlassFrog API endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.