connector.installed
A connector was installed on a project: a pending installation with no credentials yet.
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_connectorcapability (Growth); the install is refusedCONNECTOR_TIER_REQUIREDand nothing fires. - The first connector's bot flow connects in one step from the dashboard, so an existing project sees
connector.connectedwithout a precedingconnector.installed.
Related events
connector.connected: the credentials handed over.connector.disconnected: the reverse.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
Header Parameters
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=.
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.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on