connector.installed

A connector was installed on a project: a pending installation with no credentials yet.

Ability to subscribeproject-connector:view

When this fires

A creator (or a token) installs a connector on a project: from the Connectors tab, through the install endpoint or the install_connector tool. Installing says "this project runs this connector" and opens the row the Connectors tab shows as pending; connecting, which hands the connector the creator's credentials, is a separate act and fires connector.connected. Installing a connector that is already installed changes nothing and fires nothing; bringing an uninstalled connector back fires this again, the row pending once more with its settings kept.

Caveats

  • A second distinct connector on a project needs the owner's multi_connector capability (Growth); the install is refused CONNECTOR_TIER_REQUIRED and nothing fires.
  • The first connector's bot flow connects in one step from the dashboard, so an existing project sees connector.connected without a preceding connector.installed.

Related events

  • connector.connected: the credentials handed over.
  • connector.disconnected: the reverse.

Header Parameters

SB-Signature*string

t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.

SB-Event-Id*string

The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.

SB-Event-Name*string

The event name, the same as the envelope's type.

Content-Type*string

Always application/json.

User-Agent*string

Always Subscriby-Webhooks/1.0.

Request Body

application/json

The signed JSON envelope posted to your endpoint.

TypeScript Definitions

Use the request body type in TypeScript.

The envelope every event is delivered in.

Response Body

Example Requests

POST/connector.installed

How is this guide?