Back to Subscriby

connector.doctor_completed

The connector doctor ran on an installation and found something different from the previous run.

Ability to subscribeproject-connector:view

When this fires

The creator pressed Run Doctor on the Connectors tab or the connector's page, an integration called the doctor endpoint or run_connector_doctor, or the platform's scheduled sweep ran, and the report differs from the one kept on the installation: a finding appeared, disappeared or changed severity or state. A run that finds exactly what the last one found fires nothing, so a nightly sweep is quiet until something moves. The installation's own verification inside the run still fires connector.status_changed when the state moved.

Caveats

  • The first run on an installation fires this event, because there is no earlier report to match; a repeat with the same findings does not.
  • A resource the connector has no place it can ask about (no space row, no legacy chat) is a warning finding, never left out.
  • Sentences are rendered in the creator's language at the time of the run; the state words are stable.

Related events

  • connector.status_changed: the installation's own verdict, fired by the verification inside the run when the state moved.

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

How is this guide?

connector.uninstalled Webhook

A connector was uninstalled from a project: its grants revoked, its resources detached, the installation row kept, with the counts of what that touched.

connector.outage_opened Webhook

A platform refused a project's live installation (token revoked or regenerated, bot deleted) and the connector entered an outage.