growsurf_get_integration_connect_link
Return a dashboard link for connecting a specific integration (e.g., Stripe, PayPal) in GrowSurf. Use when a user wants to set up an integration, providing them the URL to open.
Instructions
Return a dashboard link that opens a specific integration's connect panel in the GrowSurf Program Editor (Options > Integrations). Use this whenever a user says they want to connect an integration, for example "connect Stripe", "set up PayPal or Wise payouts", "send Tango Card gift cards", or "sync signups to Mailchimp": call it with the integration key and give the user the returned url to open. Connecting an integration happens in the dashboard, not through the API. GrowSurf cannot link a Stripe, PayPal, Wise, or other account on the user's behalf, so hand them the link. integration must be one of the supported keys (some are camelCase, e.g. constantContact, helpScout). The link points at GROWSURF_CAMPAIGN_ID; pass campaignId to target a different program. The program is checked before the link is returned, and the result also reports whether the integration is already connected, enabled, or autoDisabled, so you can skip handing over a link the user does not need. If that check cannot run, programVerified comes back false and you still get a working production link. Tango Card, Tremendous, and Bask Health apply to referral programs only. Wise applies to affiliate programs only.
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`. |