v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-102991198.1 KB
Schemas

List Destination Type Schemas

Returns a list of JSON-based input schemas for each available destination type.

get/destination-types

Response

A list of destination type schemas.

typestring
labelstring
descriptionstring
iconstring

SVG icon string.

instructionsstring

Markdown instructions.

Example response

[
  {
    "type": "webhook",
    "label": "Webhook",
    "description": "Send event via an HTTP POST request to a URL",
    "icon": "<svg />",
    "instructions": "Some *markdown*",
    "setup_link": {
      "href": "https://dashboard.hookdeck.com/connect",
      "cta": "Generate Hookdeck Token"
    },
    "config_fields": [
      {
        "key": "url",
        "type": "text",
        "label": "URL",
        "description": "The URL to send the event to",
        "required": true,
        "default": "default_value",
        "maxlength": 255,
        "pattern": "^[a-zA-Z0-9_]+$",
        "options": [
          {
            "label": "PLAIN",
            "value": "plain"
          }
        ]
      }
    ],
    "credential_fields": [
      {
        "key": "url",
        "type": "text",
        "label": "URL",
        "description": "The URL to send the event to",
        "required": true,
        "default": "default_value",
        "maxlength": 255,
        "pattern": "^[a-zA-Z0-9_]+$",
        "options": [
          {
            "label": "PLAIN",
            "value": "plain"
          }
        ]
      }
    ]
  }
]