Skip to main content

​
What’s supported

​
Supported actions

This connector supports:
  • Read Actions, including full historic backfill. Please note that incremental read is supported only for call, prospectmails and callanalysis currently. For all other objects, a full read of the Outplay instance will be done per scheduled read.
  • Write Actions.
  • Proxy Actions, using the base URL https://{{.workspace}}-api.outplayhq.com.

​
Supported objects

The Outplay connector supports writing and reading from the following objects:
Note: The call object requires incremental read to be configured. Without it, only records from the last 30 days will be read.

​
Example integration

For an example manifest file of an Outplay integration, visit our samples repo on GitHub.

​
Before you get started

You’ll need an Outplay account and API credentials to use this connector.

​
Creating Outplay credentials

  1. Log into your Outplay account.
  2. Navigate to Settings → API Settings.
  3. Generate an API key if you haven’t already.
  4. Note your workspace identifier - this is the subdomain in your Outplay URL (e.g., if your Outplay URL is https://mycompany-api.outplayhq.com, your workspace is mycompany).

​
Using the connector

This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) To start integrating with Outplay:
  • Create a manifest file like the example above.
  • Deploy it using the amp CLI.
  • If using Read or Write actions: create a destination.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for their API credentials and workspace location.
  • Start using the connector!
    • If your integration has Read Actions, you’ll start getting webhook messages.
    • If your integration has Write Actions, you can start making API calls to our Write API.
    • If your integration has Proxy Actions, you can start making Proxy API calls.