Get a Shopify or WhatsApp browser connection handoff
Returns a browser link for an organization administrator.
GET
Returns a browser link for an organization administrator. Shopify opens the saved check-in when setupId is supplied and the Shopify integration page otherwise. WhatsApp opens its settings page with the specified account, if any, even when setupId is supplied. Provider authorization takes place in the browser.
apiKeyheader
x-api-key<token>provider*stringValue in
"shopify""whatsapp"integrationAccountId?stringMatch
^intgacct_[0-9a-hjkmnp-tv-z]{16,24}$whatsappAccountId?stringMatch
^waba_[0-9a-hjkmnp-tv-z]{16,24}$setupId?stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidRecipeHandoff
application/json- response
url*stringorganizationSlug*stringsetupId*|nullimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.integrationCatalog.recipeConnectionHandoff({
"provider": "shopify"
});Example Response
{
"url": "string",
"organizationSlug": "string",
"setupId": "f4709ab9-abc4-47f4-b2d4-4bb2be280931"
}