Skip to main content

initializeSegmentIntegration

Starts the Segment install flow and returns a browser redirect URL for consent. After installation the browser returns to returnUrl with segment_status=ok, or segment_status=error and segment_error. Requires installation view access.

initializeSegmentIntegration(
  returnUrl: String!
): InitializeSegmentIntegrationResult

Arguments​

initializeSegmentIntegration.returnUrl ● String! non-null scalar​

Post-install return path starting with /, or an HTTP(S) URL on an allowed application host.

Type​

InitializeSegmentIntegrationResult object​

Browser handoff returned by initializeSegmentIntegration to complete the Segment installation flow.