Skip to main content

Use the Stripe demo records

Seed and use the Stripe Commerce Operations demo records for consistent Payloads documentation examples and screenshots.

Use the Stripe demo records

The Stripe demo records give you a stable, realistic example Integration for learning Payloads and capturing documentation screenshots.

The demo is designed to show multiple Payload types, Credentials, Transformations, Data Queries, request and response bodies, Data Targets, and Jobs without using live customer data. It gives the documentation a consistent story: a Salesforce org using Payloads to model checkout, payment events, fulfilment, status lookups, and supporting authentication.

Use the demo when you want screenshots and examples to stay consistent across releases.

The Stripe Commerce Operations Integration record showing demo Payloads, Credentials, and Transformations.

The Stripe demo groups the configuration records used across the documentation examples.

What the demo shows

The Stripe Commerce Operations demo models common payment and fulfilment workflows.

It includes examples such as:

  • creating a checkout session from Salesforce data

  • receiving a payment event

  • returning Salesforce data to a caller

  • sending a fulfilment update

  • handling email-style operational input

  • maintaining a bearer token credential flow

  • mapping line items from child records

  • updating Salesforce records from response or inbound data

The Integration description includes a link to the Stripe API documentation so the demo can be compared with a real external API shape. The records are still demo-safe, but the structure is close enough to real REST API work to make the articles easier to follow.

Why use seeded records

Seeded records keep screenshots and examples consistent.

Use them when writing or updating help centre articles so names, values, Job statuses, and related records are predictable.

Do not use ad hoc records such as New integration or temporary test Payloads in screenshots. Clean those up before capturing images. Screenshots are easier for users to follow when every article uses the same Integration names and demo values.

Seed the records

Use the repo scripts to seed the demo org.

Run the Stripe seed scripts against the documentation demo org when the sample data needs to be refreshed.

The demo scripts create or update records rather than relying on manual setup. That makes the article screenshots repeatable between releases and reduces the chance that one article quietly drifts away from the rest of the documentation.

Demo-safe credentials

The Stripe demo uses demo-safe credential values.

Do not use real Stripe keys, live customer credentials, or production endpoint secrets in screenshots.

If you need to show a Credential, use the seeded test API key or demo bearer token Credential. The point is to show the configuration pattern without exposing anything that could be mistaken for a live secret.

Demo Jobs

The seeded Jobs cover multiple statuses and runtime outputs.

Use them when writing runtime articles because they show realistic request bodies, response bodies, Data Query output, Data Target output, response statuses, and performance metrics.

That makes runtime documentation much easier to write well. Instead of inventing abstract examples, you can point to a completed or failed Stripe demo Job and explain the exact fields a user should inspect.

For Job details, see Understand Job records.

Screenshot rules

Before taking screenshots:

  • seed or refresh the demo records

  • remove temporary records that would distract from the article

  • use the standard screenshot viewport and browser settings

  • capture the custom Payloads UI, not standard Element or Target Field record pages

  • use demo-safe values only

  • keep image descriptions concise and useful

What to check

Before using the demo in an article, check that:

  • the Stripe Commerce Operations Integration exists

  • the expected Payloads are present

  • Credentials are demo-safe

  • Transformations are named clearly

  • Data Queries and Data Targets are populated

  • Job records include the statuses and runtime data needed by the article

  • screenshots do not show temporary setup records

If the demo records drift, reseed them rather than fixing screenshots manually.

Did this answer your question?