Skip to main content

Connector Schema service overview

The Connector Schema service returns the schema for a Notification Center connector of a given type (for example, Slack, generic HTTPS, or PagerDuty). The response contains both connector_config_schema — the fields needed to configure the connector itself — and one or more message_config_schemas, which define the preset (message) fields for that connector type. Each schema lists every field’s name, type, allowed values, and whether it is required. Check connector_config_schema before creating a connector and message_config_schemas before creating a preset. Learn more in our documentation.

Authentication and permissions

To use the Connector Schema service API you need to create a personal or team API key. The key needs one of the following permissions.

Common error response codes