HOhookdeck
Operator Events

List Operator Event Destination Type Schemas

Changed on

Returns the destination types an operator event destination may use, with the config and credentials fields each type takes.

This endpoint is only available on managed Outpost.

get/operator-events/destination-types

Request

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

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

Changes