---
title: "List Operator Event Destination Type Schemas"
method: GET
path: "/operator-events/destination-types"
tags: ["Operator Events"]
---

# List Operator Event Destination Type Schemas

`GET /operator-events/destination-types`

## Request

- Base URL: `https://api.outpost.hookdeck.com/2025-07-01`
- URL: `https://api.outpost.hookdeck.com/2025-07-01/operator-events/destination-types`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

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.

## Response `200`

A list of destination type schemas.

- DestinationTypeSchema[]
  - `type` string
  - `label` string
  - `description` string
  - `icon` string: SVG icon string.
  - `instructions` string: Markdown instructions.
  - `setup_link` object: Some destinations may have an OAuth flow or other managed-setup flow that can be triggered with a link. If a `setup_link` is set then the user should be prompted to follow the link to configure the destination. See the [building your own UI guide](https://outpost.hookdeck.com/guides/building-your-own-ui.mdx) for recommended UI patterns and wireframes for implementation in your own app.
    - `href` string, url, required: The URL to direct the user to for setup.
    - `cta` string, required: The call-to-action button text to display to the user.
  - `config_fields` DestinationSchemaField[]: Config fields are non-secret values that can be stored and displayed to the user in plain text.
    - `key` string, required: Property name for this value inside the destination `config` or `credentials` object on create/update (for example `url` for a webhook endpoint URL). This is the key used to store and retrieve the field value in the destination's config or credentials object.
    - `type` 'text' | 'checkbox' | 'key_value_map' | 'select', required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `sensitive` boolean: Indicates if the field contains sensitive information.
    - `default` string: Default value for the field.
    - `minlength` integer: Minimum length for a text input.
    - `maxlength` integer: Maximum length for a text input.
    - `pattern` string: Regex pattern for validation (compatible with HTML5 pattern attribute).
    - `options` object[]: Available options for select fields.
      - `label` string, required
      - `value` string, required
  - `credential_fields` DestinationSchemaField[]: Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.
    - `key` string, required: Property name for this value inside the destination `config` or `credentials` object on create/update (for example `url` for a webhook endpoint URL). This is the key used to store and retrieve the field value in the destination's config or credentials object.
    - `type` 'text' | 'checkbox' | 'key_value_map' | 'select', required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `sensitive` boolean: Indicates if the field contains sensitive information.
    - `default` string: Default value for the field.
    - `minlength` integer: Minimum length for a text input.
    - `maxlength` integer: Maximum length for a text input.
    - `pattern` string: Regex pattern for validation (compatible with HTML5 pattern attribute).
    - `options` object[]: Available options for select fields.
      - `label` string, required
      - `value` string, required

## Other responses

- `401`: Missing or invalid authentication credentials.
- `500`: Unexpected server error.

## Changes

- **2026-10-02** `a4ddd5c7a824`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hookdeck/apis/outpost-api/changes/operator-events/destination-types/get.md)

---

[API](https://skmtc.dev/hookdeck/apis/outpost-api.md) - [All operations](https://skmtc.dev/hookdeck/apis/outpost-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hookdeck/apis/outpost-api/revisions/10262afe0dba?raw)