Connects your Flowgear Workflow to the supported Agency External API operations by using the embedded OpenAPI catalog.
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.
Use this Connection to store the Agency API settings used by all Agency methods.
| Property |
Type |
Description |
Base Url |
String |
Agency API base URL. Leave the default value unless Agency gives you a different absolute host. |
X-Api-Key |
Masked |
API key sent in the X-Api-Key header for connection validation and runtime calls. |
Timeout (seconds) |
Integer |
Request timeout used for connection validation and runtime calls. |
- 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.
- Deploy the package that matches your runtime. The current Agency Node supports both
net8.0 and net10.0.
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.
Use this method for supported Agency read operations. The Node handles Agency paging internally and emits one row per returned item for list responses.
| Parameter |
Type |
Description |
Connection |
Connection |
Agency Connection details. |
OperationId |
String |
Template-selected Agency operation identifier. |
Options |
Object |
Path and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Object |
Normalized Agency response payload for the current row. |
Paging |
Object |
Paging metadata for paged list operations when Agency returns it. |
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, and any array properties inside that object are sent as JSON arrays.
| Parameter |
Type |
Description |
Connection |
Connection |
Agency Connection details. |
OperationId |
String |
Template-selected Agency operation identifier. |
Options |
Object |
Path and query values required by the selected operation. |
Items |
Array |
JSON request-body items for the selected operation when that operation requires a request body. |
| Return |
Type |
Description |
Response |
Object |
Normalized Agency response payload for the current row. |
Paging |
Object |
Paging metadata when the selected operation returns paged results. |
Use this method for supported Agency PUT operations such as whole-resource replacements or set-style updates. Each emitted Items object is serialized independently, and any array properties inside that object are sent as JSON arrays.
| Parameter |
Type |
Description |
Connection |
Connection |
Agency Connection details. |
OperationId |
String |
Template-selected Agency operation identifier. |
Options |
Object |
Path and query values required by the selected operation. |
Items |
Array |
JSON request-body items for the selected operation when that operation requires a request body. |
| Return |
Type |
Description |
Response |
Object |
Normalized Agency response payload for the current row. |
Paging |
Object |
Paging metadata when the selected operation returns paged results. |
Use this method for supported Agency PATCH operations such as property updates and partial updates. Each emitted Items object is serialized independently, and any array properties inside that object are sent as JSON arrays.
| Parameter |
Type |
Description |
Connection |
Connection |
Agency Connection details. |
OperationId |
String |
Template-selected Agency operation identifier. |
Options |
Object |
Path and query values required by the selected operation. |
Items |
Array |
JSON request-body items for the selected operation when that operation requires a request body. |
| Return |
Type |
Description |
Response |
Object |
Normalized Agency response payload for the current row. |
Paging |
Object |
Paging metadata when the selected operation returns paged results. |
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, and any array properties inside that object are sent as JSON arrays.
| Parameter |
Type |
Description |
Connection |
Connection |
Agency Connection details. |
OperationId |
String |
Template-selected Agency operation identifier. |
Options |
Object |
Path and query values required by the selected operation. |
Items |
Array |
Optional JSON request-body items when the selected delete operation requires them. |
| Return |
Type |
Description |
Response |
Object |
Normalized Agency response payload for the current row. |
Paging |
Object |
Paging metadata when the selected operation returns paged results. |
- The Node always returns a
Response object that includes Response.Flowgear.IsSuccess.
- The template return contract matches the runtime row shape. The normalized provider payload is exposed under
Response, and paged rows include Paging in the same row contract.
Response.Flowgear.Message is only included when Agency returns user-actionable detail such as a handled failure or partial-success warning.- Paged list operations copy Agency paging fields such as
cursor, has_more, count, total_count, or next_cursor into the top-level Paging object.
- 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.
- Connection validation uses Agency's low-risk test route, but that route is intentionally hidden from the public template surface.
- The Node follows Agency-managed redirects for supported operations, but deprecated account-people redirect routes remain hidden from templates.
POST /v1/meetings/{source_id}/audio is not exposed in this version because it requires multipart/form-data handling instead of the JSON-first runtime used by the current Node.