Get Integration Connect Link
growsurf_get_integration_connect_linkGet a GrowSurf dashboard link to an integration's connect panel so users can complete account setup when the API cannot connect it for them.
Instructions
Return a dashboard link to an integration's connect panel in the GrowSurf Program Editor (Options > Integrations). Connecting Stripe, PayPal, Wise, or another account requires the user to complete the dashboard flow; the API cannot connect an account on their behalf. integration accepts supported keys, including camelCase keys such as constantContact and helpScout. The result reports whether the integration is connected, enabled, or autoDisabled. If the program check cannot run, programVerified is false and the result still includes a production dashboard link. Tango Card, Tremendous, and Bask Health apply only to referral programs. Wise applies only to affiliate programs. Targets campaignId if supplied, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | No | Target program for the link. Defaults to GROWSURF_CAMPAIGN_ID. | |
| integration | Yes | The integration to connect. Must exactly match one of the supported keys (for example `wisecom`; some are camelCase, e.g. `constantContact`, `campaignMonitor`, `helpScout`, `pabblyConnect`, `baskHealth`). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Dashboard link that opens the integration's connect panel. | |
| note | No | Instructions to relay to the user. | |
| label | No | Human-readable integration name. | |
| enabled | No | Whether the integration is switched on and currently working. Present only when `programVerified` is `true`. | |
| category | No | The integration's category. | |
| connected | No | Whether the program has stored credentials for this integration. Present only when `programVerified` is `true`. | |
| integration | No | The integration key that was requested. | |
| autoDisabled | No | Whether GrowSurf switched the integration off after repeated delivery failures. Present only when `programVerified` is `true`. | |
| referralOnly | No | `true` when the integration applies to referral programs only. | |
| affiliateOnly | No | `true` when the integration applies to affiliate programs only. | |
| programVerified | No | `true` when the program's live integration list was read, so the program id is confirmed and the three state fields below are present and current. `false` when that read was unavailable, for example without an API key or `program:read`: the link still works but points at the production dashboard, and the state fields are omitted because the state is unknown. Never treat an absent state field as `false`. |