Agency v2

Provides integration with Agency, an insurance-management platform that exposes supported policy, customer, and operational data through its External API.

The Node connects your Flowgear Workflow to the supported Agency External API operations by using an embedded OpenAPI catalog.

Revision History

0.0.0.1 - Initial release.
0.0.0.4 - Updated the Node for net8.0 and net10.0 deployments.
0.0.0.6 - Preserved nested array values in request bodies, omitted optional empty formatted fields, and aligned the template return contract with the runtime row shape.
0.0.0.7 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.0.0.9 - Maintenance release.

Connection

Use this Connection to store the Agency API settings used by all Agency methods.

Setup Notes

• Create an Agency API key with access to the operations your Workflow will call.
• Create a Flowgear Connection and keep Base Url at https://api.agency.inc/external unless Agency instructs you to use another host.
• Enter your X-Api-Key and confirm Timeout (seconds) is greater than 0.
• Run the Connection test before you build method templates so Flowgear can verify the key against Agency's low-risk validation route.
• Ensure the key includes any route-specific scopes that your selected operation needs. Some Agency operations also require admin access.

Methods

The Node exposes the supported non-deprecated JSON Agency API surface through five action-oriented method groups. GET /v1/zapier/test, the deprecated account-people routes, and the deferred multipart audio upload route are not exposed in templates.

Query

Use this method for supported Agency read operations. The Node handles Agency paging internally and emits one row per returned item for list responses.

Create

Use this method for supported Agency create-style POST operations. It also covers Agency actions that are modeled as POST requests. When you supply multiple Items, the Node sends one request per item and returns one row per request. Each emitted Items object is serialized independently, nested array properties stay as JSON arrays, and optional empty formatted values are omitted from the outbound payload when Agency expects the field to be absent.

Replace

Use this method for supported Agency PUT operations such as whole-resource replacements or set-style updates. Each emitted Items object is serialized independently, nested array properties stay as JSON arrays, and optional empty formatted values are omitted from the outbound payload when Agency expects the field to be absent.

Update

Use this method for supported Agency PATCH operations such as property updates and partial updates. Each emitted Items object is serialized independently, nested array properties stay as JSON arrays, and optional empty formatted values are omitted from the outbound payload when Agency expects the field to be absent.

Delete

Use this method for supported Agency DELETE operations. Most delete operations use only Options, but templates include Items when Agency documents a JSON delete body. When a delete operation accepts Items, each emitted object is serialized independently, nested array properties stay as JSON arrays, and optional empty formatted values are omitted from the outbound payload when Agency expects the field to be absent.

Usage Notes

• The designer exposes one top-level Response return object. The normalized provider payload is available under Response.Response, and paged operations expose paging metadata under Response.Paging.
• The nested payload under Response.Response always includes Response.Response.Flowgear.IsSuccess.
• Response.Response.Flowgear.Message is always included. It contains Agency's detail when available, such as a handled failure message, and otherwise a standard success or failure message.
• Mutation rows can also include Response.Response.Flowgear.Request, which contains the request values sent for that row.
• Agency error payloads are kept under Response.Response.error and the row is marked with Response.Response.Flowgear.IsSuccess set to false.
• Paged list operations copy Agency paging fields such as cursor, has_more, count, total_count, or next_cursor into Response.Paging.
• Mutation methods serialize each emitted Items object as its own request body. Nested array properties stay as JSON arrays in the outbound payload.
• Optional empty formatted values, such as blank date fields, are omitted from the outbound request body instead of being sent as empty strings.
• Wrapped Agency data[] responses emit one row per returned item. Wrapped data objects are unwrapped into Response.Response.
• Connection validation uses Agency's low-risk test route, but that route is hidden from method templates.
• The Node follows Agency-managed redirects for supported operations, but deprecated account-people redirect routes remain hidden from templates.
• A 401 response means the API key was rejected. Update X-Api-Key in the Connection with a valid key.

Known Issues

• POST /v1/meetings/{source_id}/audio is not exposed in this version because it requires multipart/form-data uploads, and the Node sends JSON request bodies only.