---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Connectors"
description: "The `connectors` collection of Sylphx Events: A Connector is one delivery channel of the environment, as stored: an email connector's allowed senders, a webhook's kind, and so on."
type: reference
product: webhooks
summary: "A Connector is one delivery channel of the environment, as stored: an email connector's allowed senders, a webhook's kind, and so on."
updated: 2026-09-28
order: 900
---

A Connector is one delivery channel of the environment, as stored: an email connector's allowed senders, a webhook's kind, and so on. It is read-only here: connectors are created and changed through `/v1/connectors`, and webhook endpoints have their own Resource. No secret or credential is ever shown.

**Service** Sylphx Events · **Resource type** `events.sylphx.com/Connector` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/connectors/{connector}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/connectors/{connector}`, where `{connector}` is the connector id of `/v1/connectors`. |
| `uid` | `string` | `con_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata; `generation` is the active revision. |
| `kind` | `string` | The channel: `email`, `webhook`, `realtime`, `push`, or `sms`. Output only. |
| `display_name` | `string` | The connector's name. Output only. |
| `state` | `string` | `active` or `disabled`. Output only. |
| `allowed_senders` | `string[]` | The sender addresses an email connector may send from; empty for other kinds. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/connectors#get) | Gets a connector. |
| `GET` | [`list`](/docs/api/connectors#list) | Lists connectors. |

## get

Gets a connector.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/connectors/connector` · scope `events:read` · effect `read` · [Request, response and examples](/docs/api/connectors/get)

## list

Lists connectors.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/connectors` · scope `events:read` · effect `read` · paginated · [Request, response and examples](/docs/api/connectors/list)