connector.connected

The creator connected an installation with their credentials; the connector can act for the project now.

Ability to subscribeproject-connector:view

When this fires

A creator completes a connector's connect flow on the dashboard: the connector checks the credentials, registers with its platform and the installation turns connected. For the first connector this is the Connect Bot modal, the platform bot's connectivity conversation and a Disaster Recovery bot replacement.

Caveats

  • Credentials are never in the payload. Read the installation back with the installation endpoint.
  • Reconnecting with new credentials fires this again for the same installation_id.

Related events

  • connector.installed: the pending row that preceded it, when the connector installs in two steps.
  • connector.status_changed: the installation's health afterwards.

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.connected

How is this guide?