Skip to Content

Stripe connection

Introduction

A Stripe connection, created using the Stripe connector, establishes access to Stripe. Once a connection is configured, you can create instances of Stripe activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Stripe connection

A new Stripe connection is created using the Stripe connector from one of these locations:

An existing Stripe connection can be edited from these locations:

Configure a Stripe connection

Each user interface element of the Stripe connection configuration screen is described below.

Stripe connection configuration

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each Stripe connection and must not contain forward slashes / or colons :. This name is also used to identify the Stripe endpoint, which refers to both a specific connection and its activities.

  • API Key: Enter the API key for the Stripe instance.

  • Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use Private agent proxy settings.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Stripe connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Search: Searches specified object data in Stripe using Stripe’s Search Query Language. This activity intended to be used as a source in an operation.

  • Read: Retrieves object data from Stripe using the object's ID and is intended to be used as a source in an operation.

  • Create: Creates object data in Stripe and is intended to be used as a target in an operation.

  • Update: Updates object data in Stripe and is intended to be used as a target in an operation.

  • Delete: Deletes object data from Stripe and is intended to be used as a target in an operation.