AhaSend · JSON Structure

Openapi V2 Route Structure

Route schema from AhaSend API

Type: object Properties: 16 Required: 7
EmailTransactional EmailDeveloper ToolsSMTPWebhooks

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

Properties

object id created_at updated_at name url recipient attachments headers group_by_message_id strip_replies enabled success_count error_count errors_since_last_success last_request_at

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/ahasend/refs/heads/main/json-structure/openapi-v2-route-structure.json",
  "name": "Route",
  "description": "Route schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "route"
      ],
      "description": "Object type identifier",
      "example": "route"
    },
    "id": {
      "type": "uuid",
      "description": "Unique identifier for the route",
      "example": "500123"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the route was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "description": "When the route was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "name": {
      "type": "string",
      "description": "Route name",
      "example": "Example Name"
    },
    "url": {
      "type": "uri",
      "description": "Webhook URL for the route",
      "example": "https://example.com"
    },
    "recipient": {
      "type": "string",
      "nullable": true,
      "description": "Recipient filter",
      "example": "example_value"
    },
    "attachments": {
      "type": "boolean",
      "description": "Whether to include attachments in route payload",
      "example": true
    },
    "headers": {
      "type": "boolean",
      "description": "Whether to include headers in route payload",
      "example": true
    },
    "group_by_message_id": {
      "type": "boolean",
      "description": "Whether to group by message ID",
      "example": true
    },
    "strip_replies": {
      "type": "boolean",
      "description": "Whether to strip reply content",
      "example": true
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the route is enabled",
      "example": true
    },
    "success_count": {
      "type": "int32",
      "description": "Number of successful calls",
      "example": 1
    },
    "error_count": {
      "type": "int32",
      "description": "Number of unsuccessful calls",
      "example": 1
    },
    "errors_since_last_success": {
      "type": "int32",
      "description": "Number of consecutive failed calls",
      "example": 1
    },
    "last_request_at": {
      "type": "datetime",
      "description": "When the route was last called",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "required": [
    "object",
    "id",
    "created_at",
    "updated_at",
    "name",
    "url",
    "enabled"
  ]
}