Skip to content
Arc XP
Search
Product Documentation
GitHub
Select theme
Dark
Light
Auto
Welcome
Discover Arc XP
Quick Start
Introduction
Setting Up Your Dev Playground
Exploring the PageBuilder Structure
Creating with PageBuilder
Configuring Environment Variables
Concepts
Developer Tools at Arc XP
Content Model and ANS
Understanding Arc Native Specification (ANS)
ANS for a Viable Video Document
ANS for a Viable Gallery Document
ANS for a Viable Image Document
Micro Experiences
New!
Introducing Micro Experiences
Micro Experience Tutorial
Micro Experience FAQs
Explainers
How Does MX Work?
Getting Access To MX
Adopting Multiple Experience Strategy and Configuring Them
Editor/Curator Guide
Developer Guide
Adopting Monorepo With MX
Planning Your MX Migration
How To Guides
Troubleshoot Issues Across MX
Identify Which MX Renders a Page
Update Traffic Routes Between MX
Preview Pages With Multiple MX
Composer Previews With Multiple MX
API
Introduction
Accessing Arc XP APIs 🔒
Clavis v3 (Arc Intelligence)
Content Administration
Arc XP iTunes Subscription API
Author API
ContentOps API
Draft API
Global Settings API
Photo API
Preview API
Sites API
Tags API
Video Center API
Integrations (IFX)
Migration Center
PageBuilder
PageBuilder Engine Deployer API
Micro Experience Service API
PageBuilder Editor Data Sync API
Public Content Retrieval
Content API
Geo Restrictions API
Video API (Public)
View API (Public)
Signing Service
Site Service
Subscriptions
Tags
Web Delivery
Delivery API
Redirects API
WebSked
Collections API
WebSked API
Components
Arc Intelligence
Clavis SDK
Clavis: Events and SIMS Recommendation Endpoints
Clavis: Filtering Popularity Results by Section
[Experimental] AI Audio Narratives
Developer Guide to Bandito
Audience Targeting
Audience Targeting: Developer guide
Author Service
How author IDs are generated
How to display stories by a given author, accounting for name changes
Composer
Developer's Guide to Power Ups
How fields in the Composer UI map to ANS
Technical Specifications for Custom Embeds (Power Up) in Composer
Content
How to Set up a Newsletter Integration with IFX
Using the Arc XP Content iOS Module
Writing and implementing complex custom content sources
Integrations (IFX)
Introduction
Managing User Access
New!
Guides and Resources
Create & Manage Integrations
Create and Manage Integrations
Creating Handlers to Receive Events with IFX
Events
IFX Events
Arc XP Content Events
Environment Variables
Using Environment Variables in Node.js
Logs & Metrics
How to Use Integration Logs with IFX (API only)
Integration Logs UI
Integration Metrics Dashboard
Bundles
Bundle Management
Secrets Management
Create a Secure Secret and Use within Your Integration
Webhooks
IFX Inbound Webhooks
Community Examples
An Introduction
Live Blogging (headless clients)
Pushing Content to Apple News
SendGrid Email Connector
How-To Guides
Locally Simulate HTTP Requests
Getting Integrations Running Locally (Java)
Upgrade IFX SDK Versions
Making HTTP Requests with Node.js
Using TypeScript and other JS Supersets in Integrations
Setting Up Newsletter Integrations
FAQ
Migration Center
Migration Center 3.0 - New Features and Key Changes
Migration Center self-serve inbound content pipelines | Transform and Load guide
Sending Multiple ANS Objects to Arc XP Services Using Migration Center
Mobile
Getting Started
How to use Arc XP content in mobile apps
Arc XP Mobile Documentation Index
Getting Started with Arc XP iOS SDK
Mobile SDK - Android Initialization
Content
Back-end setup for Mobile SDK
Mobile SDK - Resolver setup
Getting started with ArcXP Content iOS Module
Arc XP Mobile SDK- Getting Started with the Android Content Module
Using Content Features with Arc XP iOS SDK
Subscriptions
Getting started with Arc XP Commerce iOS Module
Arc Subscriptions (Commerce) Module - Getting Started with the Commerce Module in Android SDK
Getting started with Arc XP Subscriptions iOS Module
Identity: Mobile SDK using Google One Tap
Introduction to the Commerce service in Arc XP iOS SDK
Mobile SDK - Using the Commerce Module Paywall - Android
Primary Paywall Components for Arc XP iOS SDK
Using Commerce Services with Arc XP iOS SDK
Using the Commerce iOS Module - Paywall
Using the Subscriptions iOS Module - Paywall
Video
Android Mobile SDK - Getting Started with the Video Module
Using Video Features with Arc XP iOS SDK
Mobile SDK Video Module: Enabling Chromecast for your Android app
Mobile SDK Video Module: Handling Errors on Android and FireTV
Mobile SDK - Implementing Video Analytics on Android
Enable Picture-in-Picture in Video Players (iOS)
Mobile SDK Video Module - Download the SDK
Sample Apps
The Arc XP (News App) Android Sample Project
The Arc XP (News App) iOS Sample Project
The Arc XP TV Android Sample Project
The Arc XP News App - Google AdMob Implementation
Firebase Setup for News App - Analytics/Push notifications
How to Add, Create and Use the Widget Feature in the ArcXP Android App
iOS NewsApp Widget Documentation
Additional Resources
Arc XP Mobile SDK Security Best Practices
Mobile SDK Android code documentation
Using Mobile SDK with React Native
Arc XP Mobile SDK - FAQ
Outbound Feeds
Core Concepts
Feature Blocks Architecture in Outbound Feeds
Outbound Feeds Development - Output Types
Outbound Feeds Environments
How-To Guides
Setting Up Feeds
Setting Up a Standard ANS Block with Outbound Feeds
Setting Up Amazon Alexa Feed with Outbound Feeds
Setting Up Facebook Instant Articles RSS Feed with Outbound Feeds
Setting Up Flipboard RSS Feed with Outbound Feeds
Setting Up Google News RSS Feed with Outbound Feeds
Setting Up Google News Sitemap Feed with Outbound Feeds
Setting Up MRSS Feed with Outbound Feeds
Setting Up MSN RSS Feed with Outbound Feeds
Setting Up Sitemap Feed with Outbound Feeds
Setting Up Sitemap Index By Day Feed with Outbound Feeds
Setting Up Sitemap Section Feed with Outbound Feeds
Setting Up Sitemap Section Front Index Feed with Outbound Feeds
Setting Up Standard ANS Block with Outbound Feeds
Setting Up Standard RSS with Outbound Feeds
Setting Up Video Sitemap Feed with Outbound Feeds
Deploying new outbound feeds features
Setting Up New Outbound Feeds Repositories
Ejecting a Block with Outbound Feeds
Managing .txt files with Outbound Feeds
Outbound Feeds Image Resizer v2 Upgrade and Configuration Guide
Outbound Feeds Development - Troubleshooting
Reference
Outbound Feeds - API Postman Library
Content Source Blocks in Outbound Feeds
Content Sources with Outbound Feeds
Custom Block Development and Outbound Feeds
Utilities for Outbound Feeds Development
Dependencies and Outbound Feeds Development
Large Sitemap Indexes in Outbound Feeds
Updating blocks.json and Outbound Feeds Development
Pagebuilder Editor
PageBuilder Editor: Export-Import Technical Documentation
Syncing PageBuilder data across environments
Pagebuilder Engine
PageBuilder Basics
Arc XP Environments
arc.config.json
Feature Pack Directory Structure
Helpful Commands
How To Run PageBuilder Engine Locally - Starting from scratch with Hello World example
Best Practices
(Fusion) CLI
Fusion Context isAdmin Use
Local Development on Apple Silicon Macs (M1/M2/M3/M4)
Local Development on M1/M2 Apple Macs
Core Concepts
Bandito and Content Testing Developer Documentation
Best Practices
Client-side PageBuilder Engine variables
Content Caching In PageBuilder Engine (Server-Side)
Custom fields in PageBuilder Engine
Environment Variables
Global Data Substitution
How does PageBuilder Engine content caching work
How Rendering Works in PageBuilder Engine
Optimizing Interaction to Next Paint (INP) metric on your pages
How Access Tokens Work in PageBuilder
Limits and Requirements
Logging Improvements
Preventing sensitive information leakage in your content sources
Universal Docker Images (same Engine version now works with Intel and ARM chips)
Versioning Policy
React Hooks
Rehydration versus Server-Side versus Client-Side (SPA) Rendering
Server-side versus client-side rendering - the best of both worlds in Arc XP
Site Properties
Using Locally Generated Webpack Stats File
Using Service Workers with PageBuilder Engine
What does the PageBuilder local development stack look like?
Working in non-Production PageBuilder environments with lower render capacity limits
How-to Guides
Choosing which browsers PageBuilder Engine to support
Code Splitting and Dynamic Import
Component and end-to-end testing your feature bundle code
Error Handling in Content Sources
Event Handling and Interaction with React Hooks
Handling redirects in content sources
How to check feature/content-source usage using pb-data analysis scripts
How to Message Between Components
How to use PageBuilder Deployer's deployment preview functionality for testing bundle code changes
How to customize content redirect behavior (301 vs 302) in your PageBuilder Bundle
How To Run PageBuilder Engine Locally - Starting with my organization's live bundle and pages
Improve local build speed with parallel build threads
Internationalization
Local Mocks
Migrating from PageBuilder Engine 3.x to 4.x
Migrating from PageBuilder Engine 4.x to 5.x
Optimize large bundles' build size with content source compilation dependency duplication
Optimize your client-side bundle size by tree shaking your dependencies
Optimizing local development environment and build speeds
Optimizing (unzipped) lambda size with pre-building large dependencies
Deployment automation using official Arc XP Deployer GitHub Action
Multi-site styling support
Partial Caching with PageBuilder Engine
Running PageBuilder Engine on Windows
Upgrading your bundle code with major or breaking PageBuilder Engine releases
Using Private NPM Repository in your bundle
How to Resize Images in PageBuilder Engine
Reference
Rendering API
Chain API
Consumer API
Content Source API
Content Component API
Context Component API
Feature API
Layout API
Output Type API
HTTP API
Plugins API
Static Content Component
Photo Center
Developer Docs
Canonical URL Service and Photo Center Integration
How to Upload an Image Using Photo API
Photo Center Image Field Mapping
Wire Photos and Expiration
Image Resizer
Migrate from Resizer v1 to v2
Phased Migration from Resizer v1 to v2
Resizer v1-to-v2 Redirects
Transform Images with Resizer v2
How to Preview Image Transformations
Resizer v2 Error Codes
Resizer v2 FAQ
Resizer v2 Known Issues
Platform Tools
Retail Public APIs
Caching Layer Overview For View API
Configuring CircleCI to automate deployments
Provisioning tokens through Delivery API
Publishing Platform
Draft API
Deep Dive: URLs in Draft API
Deleting a Document
Draft API Interactions with ANS
Revisions endpoint changes in upgraded version
Getting Started with the Draft API
How To Restore A Document From An Older Revision
Content API
Content API Query Reference
Searching for Highly Paginated Documents
Site Service
Quick-selecting groups for Site Service
Subscriptions
Getting Started
Migrating to Arc XP Subscriptions
CDP and the Arc XP Paywall
Getting Started with Arc XP Subscriptions
Getting Started with Sales in Arc XP Subscriptions
Getting Started with the Arc XP Subscriptions Paywall
Group Packages and Gifts in Arc XP Subscriptions
How-To Guides
Arc XP Paywall: Customer Segmentation Targeting
Arc XP Paywall: Reducing Paywall AvoidanceÂ
Arc XP Paywall: Rule Capabilities
Arc XP Subscriptions - Active Subscription Renewal Offboarding Migration
Guide to using Entitlements with your paywall
How to Set Up Google Reader Revenue Manager Enterprise with Arc XP Subscriptions
How to Set up Vindicia Integration
How to Use AMP with Arc XP Subscriptions
How to use Zephr with Arc Subscriptions
Server-side Paywall Best Practices
Developer Docs
Arc XP Paywall: Integrating Google Extended Access
Arc XP Subscriptions SDKs
Developers guide to setting up a Paywall
How to Build a Server-side Paywall with Arc Subscriptions or an External System
Events
Retention Economics - Proven Methods for Maximizing Audience Retention
Diagnosing Common Issues
Tips for Asking for Help with Arc XP Subscriptions
Troubleshooting Paywall Issues
Identity
Introduction
The basics
What is an Arc XP Identity account
How-to: Connect and log in with Arc XP Identity SDKs and APIs on the Web
Personas
Security
Arc XP Identity Security best practices
Security and Arc XP Identity
Password Settings: Secure your user's accounts with password requirements
User account configuration: Manage sessions, automatic account deletion, device limits, and account locks
Secure your site against attacks: CORS Domains, Blocked email domains & ReCAPTCHA
Registration and Login
Authentication: Social, OIDC, password and one-time access link
Setup third-party authentication providers: Facebook, Google, Apple, and OIDC
How-to: Implement social sign in
Implement registration, login and one-time-access link
How-to use Arc XP Identity as IDP (OIDC)
Setup Arc XP Identity as an OIDC provider
Setup Arc XP Identity as an OIDC client
How-to: Implement social sign in using OIDC: Arc XP Identity
How-to: Implement social sign in using OIDC: Apple
Account management
Parameters: Regex Expressions for Arc XP Identity APIs
Manage user accounts: Developer interface
Manage user accounts: CSR perspective
Manage user accounts: Reader experience
How-to: Implement registration, login and one-time-access link
How-to listen Web Socket events and Implement IFX email service provider
List of Identity web socket events
Themes blocks
Arc XP Identity Themes Blocks configuration & Customization Deep Dive
Quickstart guide: Register and Login on the Web with the Arc XP Subscriptions Themes Blocks
Migrations and data extraction
How-to use the data extraction framework to bulk download user data
Use Identity developer APIs to migrate users into Arc XP Identity
Cognito migration in Arc XP Identity
Sales
The basics
Subscription basic: Features and concepts
What is a subscription in Arc XP
Set up products and prices
Set up and publish offers
How-to: Connect with Arc XP Sales SDKs and APIs on the web
Personas
Security
Arc XP Sales: Security best practices
Purchases
Payment gateway providers
Set up taxes: custom taxes and external integrations
Checkout to purchase a subscription
How to add IFX integration as a payment provider
How to add Stripe Intents as a payment provider
How to add PayPal Clasic as a payment provider
How to add Braintree as a payment provider
Renewals
Payment optimization
Smart Dunning
Subscription management
Subscription managment: CSR perspective
Subscription management: Reader experience
Subscription management: Developer interface
List of web socket events
Migration and data extraction
How-to use the data extraction framework to bulk download user data
Use Sales developer APIs to migrate subscriptions into Arc XP Subscriptions
Themes
Introduction to Themes Design System
Migrating Data for Arc Blocks
Migrating from Theme Settings UI to PageBuilder Deployer
Environment Settings
Local Development Process for Custom Blocks
Ejecting (Forking) an Arc Block
Upgrade to v2 Arc Blocks
Creating a Custom Block with Styling
Components and Blocks Storybook
Themes CSS Framework
CSS Logical Properties on Arc Blocks
Upload Custom Block Bundles to Theme Settings API
Themes FAQ
Video Center
Video Center Player
Video Center Player Basics
Advertising in the Video Center Player
Events
Looping Videos
Promo Screen
Customization
Container
Custom Captions
Default Colors
Round Player Corners
Scrubber
Settings
How-to Guides
Debugging Checklist
Update Video ANS Programmatically
Video Without Video Center
Plugins
Discovery Plugin
Google Analytics Plugin
Share Plugin
Sticky Plugin
Tizen
Mobile Video Module
Mobile Video Module Basics
Getting Started with the Mobile Video Module
Getting Started with the iOS SDK
Controlling Video Playback with the iOS SDK
Customization
Customizing the Player on iOS
Customizing Your Player on Android
How-to Guides
Configuring Advertising in the Android Video Module
Configuring the Video Player on Android
Configuring Ads with the iOS SDK
Configuring Closed Captioning on iOS and tvOS
Configuring the Arc SDK Client on iOS and tvOS
Reference
Callbacks on iOS and tvOS
FAQs
Video Encoding Fails with Error Resulting In Invalid Captions Format Error in Playback
Web Delivery
Real user monitoring beacons and maintaining regulatory compliance
Reserved URL Paths and Patterns
Web Application Firewall (WAF) Update Log
Web Delivery Error Handling
WebSked
WebSked machine-readable events
GitHub
Select theme
Dark
Light
Auto
Retention Economics - Proven Methods for Maximizing Audience Retention
Download Pugpig’s Retention Economics report
