HOhookdeck
Schemas

Get Destination Type Schema

Changed on

Returns the input schema for a specific destination type.

get/destination-types/{type}

Request

  • Base URL
    https://api.outpost.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP bearer

Response

The schema for the specified destination type.

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"
        }
      ]
    }
  ]
}

Changes

  • 14c241298c37Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 4ba37d03a8daRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status