Sign in
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.

remote_setup_urlstring url

Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a remote_setup_url is set then the user should be prompted to follow the link to configure the destination. See the building your own UI guide for recommended UI patterns and wireframes for implementation in your own app.

Example response

[
  {
    "type": "webhook",
    "label": "Webhook",
    "description": "Send event via an HTTP POST request to a URL",
    "icon": "<svg />",
    "instructions": "Some *markdown*",
    "remote_setup_url": "https://dashboard.hookdeck.com/authorize?provider=acme",
    "config_fields": [
      {
        "type": "text",
        "label": "URL",
        "description": "The URL to send the event to",
        "required": true,
        "default": "default_value",
        "maxlength": 255,
        "pattern": "^[a-zA-Z0-9_]+$"
      }
    ],
    "credential_fields": [
      {
        "type": "text",
        "label": "URL",
        "description": "The URL to send the event to",
        "required": true,
        "default": "default_value",
        "maxlength": 255,
        "pattern": "^[a-zA-Z0-9_]+$"
      }
    ]
  }
]

Changes