Schemas
Get Destination Type Schema
Returns the input schema for a specific destination type.
get/destination-types/{type}
Response
The schema for the specified destination type.
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"
}
]
}
]
}