Ampersand · JSON Structure

Ampersand Api Destination With Secrets Structure

Destination object with secrets field (returned by getDestination when includeSecrets is true)

Type: object Properties: 7 Required: 5
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

DestinationWithSecrets is a JSON Structure definition published by Ampersand, describing 7 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name type metadata createTime updateTime secrets

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-destination-with-secrets-structure.json",
  "name": "DestinationWithSecrets",
  "description": "Destination object with secrets field (returned by getDestination when includeSecrets is true)",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The destination ID."
    },
    "name": {
      "type": "string",
      "description": "User-defined name for the destination",
      "example": "leadConvertedWebhook"
    },
    "type": {
      "type": "string",
      "description": "The type of the destination",
      "example": "webhook"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "Webhook URL",
          "example": "https://webhooks.mailmonkey.com/salesforce-lead-converted"
        },
        "headers": {
          "$ref": "#/components/schemas/WebhookHeaders"
        },
        "streamName": {
          "type": "string",
          "description": "The name of the Kinesis stream",
          "example": "my-data-stream"
        },
        "region": {
          "type": "string",
          "description": "The AWS region for the destination",
          "example": "us-east-1"
        },
        "partitionKeyTemplate": {
          "type": "string",
          "description": "Template for generating partition keys",
          "example": "{{.integration_id}}"
        }
      }
    },
    "createTime": {
      "type": "datetime",
      "description": "The time the destination was created."
    },
    "updateTime": {
      "type": "datetime",
      "description": "The time the destination was updated."
    },
    "secrets": {
      "type": "object",
      "description": "Destination secrets (only included when includeSecrets is true)",
      "properties": {
        "webhookSigningKey": {
          "type": "string",
          "description": "Webhook signing key for the destination (only included for webhook destinations)"
        }
      }
    }
  },
  "required": [
    "id",
    "name",
    "type",
    "metadata",
    "createTime"
  ]
}