AhaSend · Schema

CreateRouteRequest

CreateRouteRequest schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
name string Route name
url string Webhook URL for the route
recipient string Recipient filter
attachments boolean Whether to include attachments in webhooks
headers boolean Whether to include headers in webhooks
group_by_message_id boolean Whether to group by message ID
strip_replies boolean Whether to strip reply content
enabled boolean Whether the route is enabled
View JSON Schema on GitHub

JSON Schema

openapi-v2-create-route-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-schema/openapi-v2-create-route-request-schema.json",
  "title": "CreateRouteRequest",
  "description": "CreateRouteRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "description": "Route name",
      "example": "Example Name"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Webhook URL for the route",
      "example": "https://example.com"
    },
    "recipient": {
      "type": "string",
      "maxLength": 255,
      "description": "Recipient filter",
      "example": "example_value"
    },
    "attachments": {
      "type": "boolean",
      "description": "Whether to include attachments in webhooks",
      "default": false,
      "example": true
    },
    "headers": {
      "type": "boolean",
      "description": "Whether to include headers in webhooks",
      "default": false,
      "example": true
    },
    "group_by_message_id": {
      "type": "boolean",
      "description": "Whether to group by message ID",
      "default": false,
      "example": true
    },
    "strip_replies": {
      "type": "boolean",
      "description": "Whether to strip reply content",
      "default": false,
      "example": true
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the route is enabled",
      "default": true,
      "example": true
    }
  },
  "required": [
    "name",
    "url"
  ],
  "example": {
    "name": "Support Route",
    "url": "https://example.com/webhook",
    "enabled": true
  }
}