Outreach v2

Connects to Outreach to read and write sales engagement data, including prospects, accounts and users. Use templates to configure reads, writes and Outreach actions that synchronize Outreach data with other systems.

Revision History

0.0.0.3 - Provides template-driven queries and mutations with automatic paging and normalized mutation responses.

Connection

Property Type Description
ClientId String OAuth application client identifier.
ClientSecret Masked OAuth application client secret.
Scopes String Space-separated application scopes. Defaults to prospects.read accounts.read users.read. Select scopes for every operation you need.
AccessToken Masked OAuth access token populated during authorization; an existing token may also be supplied.
RefreshToken Masked OAuth refresh token used for automatic renewal.
OAuthState Masked Managed during authorization. Start authorization again if this value is lost.
TokenIssuedAt DateTime Managed token issuance timestamp used to control renewal.

Setup Notes

  1. Register an Outreach OAuth application and configure the callback URI shown by Flowgear.
  2. Enter ClientId, ClientSecret and Scopes, then connect your account. Write permission does not imply read permission.
  3. Test the Connection using an account with users.read permission. Both your account permissions and the application's OAuth scopes determine which operations you can perform.
  4. Select a Method and operation template. Fill in Options and connect request data for writes.

Methods

Select a Method and its template to populate the operation and its supported fields.

Query

Reads resources with automatic cursor paging. Use Filter only for a template that declares a POST search body.

Parameter Type Description
Connection Connection Outreach Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Filter Object Optional body for a documented POST search. Ordinary query filtering is supplied through the selected Options fields.
Return Type Description
Response Array Outreach records without added mutation status fields.

Create

Creates resources or executes the selected POST action.

Parameter Type Description
Connection Connection Outreach Connection profile.
OperationId String Operation identifier populated by the selected template.
Items Array Complete request bodies, one item per Outreach request.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Outreach results with Flowgear.IsSuccess, Flowgear.Message, and a copy of the input in Flowgear.Request.

Update

Updates the resource selected by the operation and route.

Parameter Type Description
Connection Connection Outreach Connection profile.
OperationId String Operation identifier populated by the selected template.
Items Array Complete request bodies, one item per Outreach request.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Outreach results with Flowgear.IsSuccess, Flowgear.Message, and a copy of the input in Flowgear.Request.

Delete

Deletes explicitly selected resources. For a delete operation that has no request body, supply an empty object ({}) in Items.

Parameter Type Description
Connection Connection Outreach Connection profile.
OperationId String Operation identifier populated by the selected template.
Items Array Complete request bodies, one item per Outreach request.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Outreach results with Flowgear.IsSuccess, Flowgear.Message, and a copy of the input in Flowgear.Request.

Usage Notes

  • Queries emit individual data resources, preserving IDs, attributes and relationships. Requested related resources appear as JSON text in each row's included field. Transport paging links and metadata are not output records.
  • Query paging is automatic. Use Options.filter as JSON text, for example {"firstName":"Sally"}, when offered by the template. The Node converts these fields to Outreach's bracket filter syntax, such as filter[firstName]=Sally. Values retain Outreach's legacy comma and range semantics.
  • When the request contains only an object wrapper such as data, the template shows the fields inside it. Supply those fields directly; the Node adds the wrapper when sending the request. If the template shows the wrapper alongside other fields, keep that structure.
  • Each item supplied to Create, Update or Delete is a complete request body. An empty input stream sends no requests.
  • Options apply to every item in a Node invocation. To use a different route, invoke the Node separately.
  • The Node validates the request and completes the first read or write before returning the output stream. It processes later pages and items as the output is consumed.
  • Errors during startup fail the invocation. Later handled write failures return rows with Flowgear.IsSuccess set to false. Check this field before running work that depends on a successful write.
  • Automatic token renewal preserves rotated refresh tokens and prevents rapid repeated renewal within 60 seconds of token issuance.
  • Known string and integer lists use CSV where the template specifies it. Quote values containing commas, quotes or newlines, and double embedded quotes. Empty text represents an empty list; "" represents one empty string. Integer lists do not accept added whitespace or fractions. Structured object arrays retain their child fields.
  • Open-ended maps, missing item definitions and deeply recursive values appear as explicitly labelled JSON text fields.

Known Issues

  • Tenant-specific custom-object schema discovery, webhook listeners, server-to-server (S2S) key authentication, asynchronous bulk-job polling and binary media operations are not provided.
  • Asynchronous actions confirm that the request was accepted. They do not confirm that the action completed.
  • New filter syntax and sparse fieldsets (requesting only selected fields in a response) are not exposed.