Ampersand · Example Payload

Ampersand Api Connection Request Example

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Ampersand Api Connection Request Example is an example object payload from Ampersand, with 11 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

providerWorkspaceRefgroupNamegroupRefconsumerNameconsumerRefproviderapiKeycustomAuthbasicAuthoauth2ClientCredentialsoauth2PasswordCredentials

Example Payload

Raw ↑ 
{
  "providerWorkspaceRef": "example-providerWorkspaceRef",
  "groupName": "example-groupName",
  "groupRef": "group-123",
  "consumerName": "example-consumerName",
  "consumerRef": "example-consumerRef",
  "provider": "example-provider",
  "apiKey": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "customAuth": {
    "apiKey": "abcd1234",
    "password": "secret"
  },
  "basicAuth": {},
  "oauth2ClientCredentials": {},
  "oauth2PasswordCredentials": {}
}