Ampersand · Schema

DestinationWithSecrets

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

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
id string The destination ID.
name string User-defined name for the destination
type string The type of the destination
metadata object
createTime string The time the destination was created.
updateTime string The time the destination was updated.
secrets object Destination secrets (only included when includeSecrets is true)
View JSON Schema on GitHub

JSON Schema

ampersand-api-destination-with-secrets-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-destination-with-secrets-schema.json",
  "title": "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": "string",
      "description": "The time the destination was created.",
      "format": "date-time"
    },
    "updateTime": {
      "type": "string",
      "description": "The time the destination was updated.",
      "format": "date-time"
    },
    "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"
  ]
}